Avalara Developer Network Developer avaTax

AvaTax API

REST interface to Avalara's enterprise tax service, AvaTax.

Have development credentials? Generate a Postman Collection with your account info!


Retrieve a single account

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/accounts/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$include

A comma separated list of child objects to return underneath the primary object.

string

Path Parameters

id
Required

The ID of the account to retrieve.

integer

Response

id

Id

integer
name
Required

Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
accountStatusId

Account Status Id

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Subscriptions]
id

Id

integer
accountId

Account Id

integer
subscriptionTypeId

Subscription Type Id

integer
subscriptionDescription

Subscription Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Users]
id

id

integer
accountId

accountId

integer
userName
Required

userName

string
firstName

firstName

string
lastName

lastName

string
email
Required

email

string
postalCode
Required

postalCode

string
securityRoleId

securityRoleId

string
companyId

companyId

integer
passwordStatus

passwordStatus

string
isActive

isActive

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Retrieve a single account now!

Input

Reset

Path Parameters

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/accounts/{id}
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/accounts/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Update a single account

Api Endpoint
PUT https://rest-sbx-preview.avalara.net/api/v2/accounts/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

id
Required

The ID of the account you wish to update.

integer

Post Body Parameters

id

Id

integer
name
Required

Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
accountStatusId

Account Status Id

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Subscriptions]
id

Id

integer
accountId

Account Id

integer
subscriptionTypeId

Subscription Type Id

integer
subscriptionDescription

Subscription Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Users]
id

id

integer
accountId

accountId

integer
userName
Required

userName

string
firstName

firstName

string
lastName

lastName

string
email
Required

email

string
postalCode
Required

postalCode

string
securityRoleId

securityRoleId

string
companyId

companyId

integer
passwordStatus

passwordStatus

string
isActive

isActive

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response

id

Id

integer
name
Required

Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
accountStatusId

Account Status Id

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Subscriptions]
id

Id

integer
accountId

Account Id

integer
subscriptionTypeId

Subscription Type Id

integer
subscriptionDescription

Subscription Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Users]
id

id

integer
accountId

accountId

integer
userName
Required

userName

string
firstName

firstName

string
lastName

lastName

string
email
Required

email

string
postalCode
Required

postalCode

string
securityRoleId

securityRoleId

string
companyId

companyId

integer
passwordStatus

passwordStatus

string
isActive

isActive

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Update a single account now!

Input

Reset

Path Parameters

Post Body

subscriptions

item 1

Add subscriptions

users

item 1

Add users
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/accounts/{id}
Method
PUT
Request
{
  "subscriptions": [
    {}
  ],
  "users": [
    {}
  ]
}
Response
 

Delete a single account

Deleting an account will delete all companies, and all account level users attached to this account.

Api Endpoint
DELETE https://rest-sbx-preview.avalara.net/api/v2/accounts/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

id
Required

The ID of the account you wish to delete.

integer

Response

Error
code

Category of the error

string
message

Short one-line message to summaryize what went wrong

string
target

What object or service caused the error?

string
Array[Details]
errorCode

Error message identifier

integer
summary

Concise summary of the message

string
details

Message details

string
faultCode

Indicates the SoapFault code

string
helpLink

URL to help for this message

string
name

Name of the message.

string
refersTo

Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.

string
severity

Severity of the message

string
source

Source of the message

string
documentation

Documentation of the message

string
Try Delete a single account now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/accounts/{id}
Method
DELETE
Request
curl -X DELETE "https://rest-sbx-preview.avalara.net/api/v2/accounts/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve all accounts

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/accounts

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$include

A comma separated list of child objects to return underneath the primary object.

string
$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
name
Required

Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
accountStatusId

Account Status Id

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Subscriptions]
id

Id

integer
accountId

Account Id

integer
subscriptionTypeId

Subscription Type Id

integer
subscriptionDescription

Subscription Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Users]
id

id

integer
accountId

accountId

integer
userName
Required

userName

string
firstName

firstName

string
lastName

lastName

string
email
Required

email

string
postalCode
Required

postalCode

string
securityRoleId

securityRoleId

string
companyId

companyId

integer
passwordStatus

passwordStatus

string
isActive

isActive

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve all accounts now!

Input

Reset

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/accounts
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/accounts" -H "Accept: application/json" -H "Authorization: "
Response
 

Create a new account

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/accounts

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Post Body Parameters

id

Id

integer
name
Required

Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
accountStatusId

Account Status Id

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Subscriptions]
id

Id

integer
accountId

Account Id

integer
subscriptionTypeId

Subscription Type Id

integer
subscriptionDescription

Subscription Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Users]
id

id

integer
accountId

accountId

integer
userName
Required

userName

string
firstName

firstName

string
lastName

lastName

string
email
Required

email

string
postalCode
Required

postalCode

string
securityRoleId

securityRoleId

string
companyId

companyId

integer
passwordStatus

passwordStatus

string
isActive

isActive

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response

id

Id

integer
name
Required

Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
accountStatusId

Account Status Id

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Subscriptions]
id

Id

integer
accountId

Account Id

integer
subscriptionTypeId

Subscription Type Id

integer
subscriptionDescription

Subscription Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Users]
id

id

integer
accountId

accountId

integer
userName
Required

userName

string
firstName

firstName

string
lastName

lastName

string
email
Required

email

string
postalCode
Required

postalCode

string
securityRoleId

securityRoleId

string
companyId

companyId

integer
passwordStatus

passwordStatus

string
isActive

isActive

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Create a new account now!

Input

Reset

Post Body

subscriptions

item 1

Add subscriptions

users

item 1

Add users
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/accounts
Method
POST
Request
{
  "subscriptions": [
    {}
  ],
  "users": [
    {}
  ]
}
Response
 

Retrieve geolocation information for a specified address

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/addresses/resolve

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Post Body Parameters

line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number

Response

Address
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
Coordinates
latitude

Latitude

number
longitude

Longitude

number
resolutionQuality

The resolution quality of the geospatial coordinates

string
Array[TaxAuthorities]
avalaraId

Avalara Id

string
jurisdictionName
Required

Jurisdiction Name

string
jurisdictionType

Jurisdiction Type

string
signatureCode

Signature Code

string
Try Retrieve geolocation information for a specified address now!

Input

Reset

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/addresses/resolve
Method
POST
Request
{}
Response
 

Retrieve a single batch

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/batches/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this batch

integer
id
Required

The primary key of this batch

integer

Response

id

The ID number of this batch

integer
name
Required

The user-friendly readable name for this batch

string
accountId
Required

The Account ID number of the account that owns this batch

integer
companyId
Required

The Company ID number of the company that owns this batch

integer
type
Required

The type of this batch

string
status

This batch's current processing status

string
options

Any optional flags provided for this batch

string
batchAgent

The agent used to create this batch

string
startedDate

The date/time when this batch started processing

string
recordCount

The number of records in this batch

integer
currentRecord

The current record being processed

integer
completedDate

The date/time when this batch was completely processed

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Files]
id

Unique BatchFile identifier

integer
batchId

BatchId that this BatchFile is associated with.

integer
name
Required

Logical Name of file (e.g. "Input" or "Error")

string
content
Required

BatchFile content

string
contentLength

Size of content in bytes

integer
contentType
Required

Content mime type (e.g. text/csv). This is used for HTTP downloading.

string
fileExtension
Required

File extension (e.g. CSV)

string
errorCount

Number of errors that occurred when processing this file.

integer
Try Retrieve a single batch now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/batches/{id}
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/batches/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Update a single batch

Api Endpoint
PUT https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/batches/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that this batch belongs to.

integer
id
Required

The ID of the batch you wish to update

integer

Post Body Parameters

id

The ID number of this batch

integer
name
Required

The user-friendly readable name for this batch

string
accountId
Required

The Account ID number of the account that owns this batch

integer
companyId
Required

The Company ID number of the company that owns this batch

integer
type
Required

The type of this batch

string
status

This batch's current processing status

string
options

Any optional flags provided for this batch

string
batchAgent

The agent used to create this batch

string
startedDate

The date/time when this batch started processing

string
recordCount

The number of records in this batch

integer
currentRecord

The current record being processed

integer
completedDate

The date/time when this batch was completely processed

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Files]
id

Unique BatchFile identifier

integer
batchId

BatchId that this BatchFile is associated with.

integer
name
Required

Logical Name of file (e.g. "Input" or "Error")

string
content
Required

BatchFile content

string
contentLength

Size of content in bytes

integer
contentType
Required

Content mime type (e.g. text/csv). This is used for HTTP downloading.

string
fileExtension
Required

File extension (e.g. CSV)

string
errorCount

Number of errors that occurred when processing this file.

integer

Response

id

The ID number of this batch

integer
name
Required

The user-friendly readable name for this batch

string
accountId
Required

The Account ID number of the account that owns this batch

integer
companyId
Required

The Company ID number of the company that owns this batch

integer
type
Required

The type of this batch

string
status

This batch's current processing status

string
options

Any optional flags provided for this batch

string
batchAgent

The agent used to create this batch

string
startedDate

The date/time when this batch started processing

string
recordCount

The number of records in this batch

integer
currentRecord

The current record being processed

integer
completedDate

The date/time when this batch was completely processed

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Files]
id

Unique BatchFile identifier

integer
batchId

BatchId that this BatchFile is associated with.

integer
name
Required

Logical Name of file (e.g. "Input" or "Error")

string
content
Required

BatchFile content

string
contentLength

Size of content in bytes

integer
contentType
Required

Content mime type (e.g. text/csv). This is used for HTTP downloading.

string
fileExtension
Required

File extension (e.g. CSV)

string
errorCount

Number of errors that occurred when processing this file.

integer
Try Update a single batch now!

Input

Reset

Path Parameters

Post Body

files

item 1

Add files
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/batches/{id}
Method
PUT
Request
{
  "files": [
    {}
  ]
}
Response
 

Delete a single batch

Api Endpoint
DELETE https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/batches/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this batch.

integer
id
Required

The ID of the batch you wish to delete.

integer

Response

Error
code

Category of the error

string
message

Short one-line message to summaryize what went wrong

string
target

What object or service caused the error?

string
Array[Details]
errorCode

Error message identifier

integer
summary

Concise summary of the message

string
details

Message details

string
faultCode

Indicates the SoapFault code

string
helpLink

URL to help for this message

string
name

Name of the message.

string
refersTo

Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.

string
severity

Severity of the message

string
source

Source of the message

string
documentation

Documentation of the message

string
Try Delete a single batch now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/batches/{id}
Method
DELETE
Request
curl -X DELETE "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/batches/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve all batches for this company

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/batches

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Path Parameters

companyId
Required

The ID of the company that owns these batches

integer

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

The ID number of this batch

integer
name
Required

The user-friendly readable name for this batch

string
accountId
Required

The Account ID number of the account that owns this batch

integer
companyId
Required

The Company ID number of the company that owns this batch

integer
type
Required

The type of this batch

string
status

This batch's current processing status

string
options

Any optional flags provided for this batch

string
batchAgent

The agent used to create this batch

string
startedDate

The date/time when this batch started processing

string
recordCount

The number of records in this batch

integer
currentRecord

The current record being processed

integer
completedDate

The date/time when this batch was completely processed

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Files]
id

Unique BatchFile identifier

integer
batchId

BatchId that this BatchFile is associated with.

integer
name
Required

Logical Name of file (e.g. "Input" or "Error")

string
content
Required

BatchFile content

string
contentLength

Size of content in bytes

integer
contentType
Required

Content mime type (e.g. text/csv). This is used for HTTP downloading.

string
fileExtension
Required

File extension (e.g. CSV)

string
errorCount

Number of errors that occurred when processing this file.

integer
@nextLink

The link to the next page of results

string
Try Retrieve all batches for this company now!

Input

Reset

Path Parameters

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/batches
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/batches" -H "Accept: application/json" -H "Authorization: "
Response
 

Create a new batch

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/batches

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this batch.

integer

Post Body Parameters[Array]

id

The ID number of this batch

integer
name
Required

The user-friendly readable name for this batch

string
accountId
Required

The Account ID number of the account that owns this batch

integer
companyId
Required

The Company ID number of the company that owns this batch

integer
type
Required

The type of this batch

string
status

This batch's current processing status

string
options

Any optional flags provided for this batch

string
batchAgent

The agent used to create this batch

string
startedDate

The date/time when this batch started processing

string
recordCount

The number of records in this batch

integer
currentRecord

The current record being processed

integer
completedDate

The date/time when this batch was completely processed

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Files]
id

Unique BatchFile identifier

integer
batchId

BatchId that this BatchFile is associated with.

integer
name
Required

Logical Name of file (e.g. "Input" or "Error")

string
content
Required

BatchFile content

string
contentLength

Size of content in bytes

integer
contentType
Required

Content mime type (e.g. text/csv). This is used for HTTP downloading.

string
fileExtension
Required

File extension (e.g. CSV)

string
errorCount

Number of errors that occurred when processing this file.

integer

Response[Array]

id

The ID number of this batch

integer
name
Required

The user-friendly readable name for this batch

string
accountId
Required

The Account ID number of the account that owns this batch

integer
companyId
Required

The Company ID number of the company that owns this batch

integer
type
Required

The type of this batch

string
status

This batch's current processing status

string
options

Any optional flags provided for this batch

string
batchAgent

The agent used to create this batch

string
startedDate

The date/time when this batch started processing

string
recordCount

The number of records in this batch

integer
currentRecord

The current record being processed

integer
completedDate

The date/time when this batch was completely processed

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Files]
id

Unique BatchFile identifier

integer
batchId

BatchId that this BatchFile is associated with.

integer
name
Required

Logical Name of file (e.g. "Input" or "Error")

string
content
Required

BatchFile content

string
contentLength

Size of content in bytes

integer
contentType
Required

Content mime type (e.g. text/csv). This is used for HTTP downloading.

string
fileExtension
Required

File extension (e.g. CSV)

string
errorCount

Number of errors that occurred when processing this file.

integer
Try Create a new batch now!

Input

Reset

Path Parameters

Post Body

item 1

files

item 1

Add files
Add Item
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/batches
Method
POST
Request
[
  {
    "files": [
      {}
    ]
  }
]
Response
 

Retrieve all batches

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/batches

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

The ID number of this batch

integer
name
Required

The user-friendly readable name for this batch

string
accountId
Required

The Account ID number of the account that owns this batch

integer
companyId
Required

The Company ID number of the company that owns this batch

integer
type
Required

The type of this batch

string
status

This batch's current processing status

string
options

Any optional flags provided for this batch

string
batchAgent

The agent used to create this batch

string
startedDate

The date/time when this batch started processing

string
recordCount

The number of records in this batch

integer
currentRecord

The current record being processed

integer
completedDate

The date/time when this batch was completely processed

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Files]
id

Unique BatchFile identifier

integer
batchId

BatchId that this BatchFile is associated with.

integer
name
Required

Logical Name of file (e.g. "Input" or "Error")

string
content
Required

BatchFile content

string
contentLength

Size of content in bytes

integer
contentType
Required

Content mime type (e.g. text/csv). This is used for HTTP downloading.

string
fileExtension
Required

File extension (e.g. CSV)

string
errorCount

Number of errors that occurred when processing this file.

integer
@nextLink

The link to the next page of results

string
Try Retrieve all batches now!

Input

Reset

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/batches
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/batches" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve a single company

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$include

A comma separated list of child objects to return underneath the primary object.

string

Path Parameters

id
Required

The ID of the company to retrieve.

integer

Response

id

Id

integer
accountId
Required

Account Id

integer
parentCompanyId

Parent Company Id

integer
sstPid

SST Pid

string
companyCode
Required

Company Code

string
name
Required

Name

string
isDefault

Is Default

boolean
defaultLocationId

Default Location Id

integer
isActive

Is Active

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
taxpayerIdNumber
Required

Tax Payer Id Number

string
hasProfile

Has Profile

boolean
isReportingEntity

Is Reporting Entity

boolean
sstEffectiveDate

SST Effective Date

string
entityNo

Entity No

integer
defaultCountry

Default Country

string
baseCurrencyCode

Base Currency Code

string
roundingLevelId

Rounding Level Id

string
cashBasisAccountingEnabled

Cash Basis Accounting Enabled

boolean
warningsEnabled

Warnings Enabled

boolean
isTest

Is Test

boolean
taxDependencyLevelId

Tax dependency Level Id

string
inProgress

In Progress

boolean
businessIdentificationNo

Business Identification No

string
Array[Contacts]
id

id

integer
companyId

companyId

integer
contactCode
Required

contactCode

string
firstName

firstName

string
middleName

middleName

string
lastName

lastName

string
title

title

string
line1

line1

string
line2

line2

string
line3

line3

string
city

city

string
region

region

string
postalCode

postalCode

string
country

country

string
email

email

string
phone

phone

string
phone2

phone2

string
fax

fax

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[FilingCalendars]
id

Id

integer
companyId

Company Id

integer
returnName
Required

Return Name

string
locationCode

If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.

string
outletTypeId

If this calendar is for a location-specific tax return, specify the location-specific behavior here.

string
paymentCurrency

Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".

string
filingFrequencyId

Filing Frequency Id

string
months

Months

integer
stateRegistrationId
Required

Tax Registration ID for this Region - in the U.S., this is for your state.

string
localRegistrationId

Tax Registration ID for the local jurisdiction, if any.

string
employerIdentificationNumber

Employer Identification Number

string
line1

Line1

string
line2

Line2

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
phone

Phone

string
customerFilingInstructions

Customer Filing Instructions

string
legalEntityName

Legal Entity Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
filingTypeId

Filing Type Id

string
eFileUsername

If you file electronically, this is the username you use to log in to the tax authority's website.

string
eFilePassword

If you file electronically, this is the password or pass code you use to log in to the tax authority's website.

string
prepayPercentage

Prepay Percentage

string
taxTypeId
Required

Tax Type Id

string
internalNotes

Internal Notes

string
alSignOn

Al Sign On

string
alAccessCode

Al Access Code

string
meBusinessCode

Me Business Code

string
iaBen

Ia Ben

string
ctReg

Ct Reg

string
other1Name

Other 1 Name

string
other1Value

Other 1 Value

string
other2Name

Other 2 Name

string
other2Value

Other 2 Value

string
other3Name

Other 3 Name

string
other3Value

Other 3 Value

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Items]
id

Id

integer
itemCode
Required

Item Code

string
companyId

Company Id

integer
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
description
Required

Description

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Locations]
id

Id

integer
companyId

Company Id

integer
locationCode
Required

Location Code

string
description

Description

string
addressTypeId

Address Type Id

string
addressCategoryId

Address Category Id

string
line1
Required

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
stateAssignedCode

State Assigned Code

string
isDefault

Is Default

boolean
county

County

string
isRegistered

Is Registered

boolean
dbaName

Dba Name

string
outletName

Outlet Name

string
effectiveDate

Start Date

string
endDate

End Date

string
lastTransactionDate

Last Transaction Date

string
registeredDate

Registered Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Nexus]
id

id

integer
companyId

companyId

integer
state
Required

state

string
jurisTypeId

jurisTypeId

string
jurisCode
Required

jurisCode

string
jurisName
Required

jurisName

string
effectiveDate

effectiveDate

string
endDate

endDate

string
shortName

shortName

string
signatureCode

signatureCode

string
stateAssignedNo

stateAssignedNo

string
nexusTypeId

nexusTypeId

string
country

country

string
sourcing

sourcing

string
accountingMethodId

accountingMethodId

string
hasLocalNexus

hasLocalNexus

boolean
localNexusTypeId

localNexusTypeId

string
hasPermanentEstablishment

hasPermanentEstablishment

boolean
taxId

taxId

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Settings]
id

Id

integer
companyId

Company Id

integer
set
Required

Set

string
name
Required

Name

string
value

Value

string
Array[TaxCodes]
id

Id

integer
taxCode
Required

Tax Code

string
taxCodeTypeId
Required

Tax Code Type Id

string
companyId

Company Id

integer
description

Description

string
parentTaxCode

Parent Tax Code

string
isPhysical

Is Physical

boolean
goodsServiceCode

Good Service Code

integer
entityUseCode

Entity Use Code

string
isActive

Is Active

boolean
isSSTCertified

Is SST Certified

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[TaxRules]
id

Id

integer
companyId

CompanyId

integer
stateFIPS

State FIPS

string
jurisName

Jurisdiction Name

string
jurisCode
Required

Jurisdiction Code

string
jurisTypeId

Jurisdiction Type Id

string
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
customerUsageType

Customer Usage Type

string
taxTypeId

Tax Type Id

string
rateTypeId

Rate Type Id

string
taxRuleTypeId

Tax Rule Type Id

string
isAllJuris

Is All Juris

boolean
value

Value

number
cap

Cap

number
threshold

Threshold

number
options

Options

string
effectiveDate

Effective Date

string
endDate

End Date

string
description

Description

string
countyFIPS

County FIPS

string
isSTPro

Is STPro

boolean
country
Required

Country

string
region
Required

Region

string
sourcing

Sourcing

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Upcs]
id

Id

integer
companyId

CompanyId

integer
upc
Required

UPC

string
legacyTaxCode

Legacy Tax Code

string
description
Required

Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
usage

Usage

integer
isSystem

IsSystem

integer
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Retrieve a single company now!

Input

Reset

Path Parameters

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{id}
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Update a single company

Api Endpoint
PUT https://rest-sbx-preview.avalara.net/api/v2/companies/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

id
Required

The ID of the company you wish to update.

integer

Post Body Parameters

id

Id

integer
accountId
Required

Account Id

integer
parentCompanyId

Parent Company Id

integer
sstPid

SST Pid

string
companyCode
Required

Company Code

string
name
Required

Name

string
isDefault

Is Default

boolean
defaultLocationId

Default Location Id

integer
isActive

Is Active

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
taxpayerIdNumber
Required

Tax Payer Id Number

string
hasProfile

Has Profile

boolean
isReportingEntity

Is Reporting Entity

boolean
sstEffectiveDate

SST Effective Date

string
entityNo

Entity No

integer
defaultCountry

Default Country

string
baseCurrencyCode

Base Currency Code

string
roundingLevelId

Rounding Level Id

string
cashBasisAccountingEnabled

Cash Basis Accounting Enabled

boolean
warningsEnabled

Warnings Enabled

boolean
isTest

Is Test

boolean
taxDependencyLevelId

Tax dependency Level Id

string
inProgress

In Progress

boolean
businessIdentificationNo

Business Identification No

string
Array[Contacts]
id

id

integer
companyId

companyId

integer
contactCode
Required

contactCode

string
firstName

firstName

string
middleName

middleName

string
lastName

lastName

string
title

title

string
line1

line1

string
line2

line2

string
line3

line3

string
city

city

string
region

region

string
postalCode

postalCode

string
country

country

string
email

email

string
phone

phone

string
phone2

phone2

string
fax

fax

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[FilingCalendars]
id

Id

integer
companyId

Company Id

integer
returnName
Required

Return Name

string
locationCode

If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.

string
outletTypeId

If this calendar is for a location-specific tax return, specify the location-specific behavior here.

string
paymentCurrency

Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".

string
filingFrequencyId

Filing Frequency Id

string
months

Months

integer
stateRegistrationId
Required

Tax Registration ID for this Region - in the U.S., this is for your state.

string
localRegistrationId

Tax Registration ID for the local jurisdiction, if any.

string
employerIdentificationNumber

Employer Identification Number

string
line1

Line1

string
line2

Line2

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
phone

Phone

string
customerFilingInstructions

Customer Filing Instructions

string
legalEntityName

Legal Entity Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
filingTypeId

Filing Type Id

string
eFileUsername

If you file electronically, this is the username you use to log in to the tax authority's website.

string
eFilePassword

If you file electronically, this is the password or pass code you use to log in to the tax authority's website.

string
prepayPercentage

Prepay Percentage

string
taxTypeId
Required

Tax Type Id

string
internalNotes

Internal Notes

string
alSignOn

Al Sign On

string
alAccessCode

Al Access Code

string
meBusinessCode

Me Business Code

string
iaBen

Ia Ben

string
ctReg

Ct Reg

string
other1Name

Other 1 Name

string
other1Value

Other 1 Value

string
other2Name

Other 2 Name

string
other2Value

Other 2 Value

string
other3Name

Other 3 Name

string
other3Value

Other 3 Value

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Items]
id

Id

integer
itemCode
Required

Item Code

string
companyId

Company Id

integer
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
description
Required

Description

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Locations]
id

Id

integer
companyId

Company Id

integer
locationCode
Required

Location Code

string
description

Description

string
addressTypeId

Address Type Id

string
addressCategoryId

Address Category Id

string
line1
Required

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
stateAssignedCode

State Assigned Code

string
isDefault

Is Default

boolean
county

County

string
isRegistered

Is Registered

boolean
dbaName

Dba Name

string
outletName

Outlet Name

string
effectiveDate

Start Date

string
endDate

End Date

string
lastTransactionDate

Last Transaction Date

string
registeredDate

Registered Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Nexus]
id

id

integer
companyId

companyId

integer
state
Required

state

string
jurisTypeId

jurisTypeId

string
jurisCode
Required

jurisCode

string
jurisName
Required

jurisName

string
effectiveDate

effectiveDate

string
endDate

endDate

string
shortName

shortName

string
signatureCode

signatureCode

string
stateAssignedNo

stateAssignedNo

string
nexusTypeId

nexusTypeId

string
country

country

string
sourcing

sourcing

string
accountingMethodId

accountingMethodId

string
hasLocalNexus

hasLocalNexus

boolean
localNexusTypeId

localNexusTypeId

string
hasPermanentEstablishment

hasPermanentEstablishment

boolean
taxId

taxId

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Settings]
id

Id

integer
companyId

Company Id

integer
set
Required

Set

string
name
Required

Name

string
value

Value

string
Array[TaxCodes]
id

Id

integer
taxCode
Required

Tax Code

string
taxCodeTypeId
Required

Tax Code Type Id

string
companyId

Company Id

integer
description

Description

string
parentTaxCode

Parent Tax Code

string
isPhysical

Is Physical

boolean
goodsServiceCode

Good Service Code

integer
entityUseCode

Entity Use Code

string
isActive

Is Active

boolean
isSSTCertified

Is SST Certified

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[TaxRules]
id

Id

integer
companyId

CompanyId

integer
stateFIPS

State FIPS

string
jurisName

Jurisdiction Name

string
jurisCode
Required

Jurisdiction Code

string
jurisTypeId

Jurisdiction Type Id

string
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
customerUsageType

Customer Usage Type

string
taxTypeId

Tax Type Id

string
rateTypeId

Rate Type Id

string
taxRuleTypeId

Tax Rule Type Id

string
isAllJuris

Is All Juris

boolean
value

Value

number
cap

Cap

number
threshold

Threshold

number
options

Options

string
effectiveDate

Effective Date

string
endDate

End Date

string
description

Description

string
countyFIPS

County FIPS

string
isSTPro

Is STPro

boolean
country
Required

Country

string
region
Required

Region

string
sourcing

Sourcing

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Upcs]
id

Id

integer
companyId

CompanyId

integer
upc
Required

UPC

string
legacyTaxCode

Legacy Tax Code

string
description
Required

Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
usage

Usage

integer
isSystem

IsSystem

integer
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response

id

Id

integer
accountId
Required

Account Id

integer
parentCompanyId

Parent Company Id

integer
sstPid

SST Pid

string
companyCode
Required

Company Code

string
name
Required

Name

string
isDefault

Is Default

boolean
defaultLocationId

Default Location Id

integer
isActive

Is Active

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
taxpayerIdNumber
Required

Tax Payer Id Number

string
hasProfile

Has Profile

boolean
isReportingEntity

Is Reporting Entity

boolean
sstEffectiveDate

SST Effective Date

string
entityNo

Entity No

integer
defaultCountry

Default Country

string
baseCurrencyCode

Base Currency Code

string
roundingLevelId

Rounding Level Id

string
cashBasisAccountingEnabled

Cash Basis Accounting Enabled

boolean
warningsEnabled

Warnings Enabled

boolean
isTest

Is Test

boolean
taxDependencyLevelId

Tax dependency Level Id

string
inProgress

In Progress

boolean
businessIdentificationNo

Business Identification No

string
Array[Contacts]
id

id

integer
companyId

companyId

integer
contactCode
Required

contactCode

string
firstName

firstName

string
middleName

middleName

string
lastName

lastName

string
title

title

string
line1

line1

string
line2

line2

string
line3

line3

string
city

city

string
region

region

string
postalCode

postalCode

string
country

country

string
email

email

string
phone

phone

string
phone2

phone2

string
fax

fax

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[FilingCalendars]
id

Id

integer
companyId

Company Id

integer
returnName
Required

Return Name

string
locationCode

If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.

string
outletTypeId

If this calendar is for a location-specific tax return, specify the location-specific behavior here.

string
paymentCurrency

Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".

string
filingFrequencyId

Filing Frequency Id

string
months

Months

integer
stateRegistrationId
Required

Tax Registration ID for this Region - in the U.S., this is for your state.

string
localRegistrationId

Tax Registration ID for the local jurisdiction, if any.

string
employerIdentificationNumber

Employer Identification Number

string
line1

Line1

string
line2

Line2

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
phone

Phone

string
customerFilingInstructions

Customer Filing Instructions

string
legalEntityName

Legal Entity Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
filingTypeId

Filing Type Id

string
eFileUsername

If you file electronically, this is the username you use to log in to the tax authority's website.

string
eFilePassword

If you file electronically, this is the password or pass code you use to log in to the tax authority's website.

string
prepayPercentage

Prepay Percentage

string
taxTypeId
Required

Tax Type Id

string
internalNotes

Internal Notes

string
alSignOn

Al Sign On

string
alAccessCode

Al Access Code

string
meBusinessCode

Me Business Code

string
iaBen

Ia Ben

string
ctReg

Ct Reg

string
other1Name

Other 1 Name

string
other1Value

Other 1 Value

string
other2Name

Other 2 Name

string
other2Value

Other 2 Value

string
other3Name

Other 3 Name

string
other3Value

Other 3 Value

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Items]
id

Id

integer
itemCode
Required

Item Code

string
companyId

Company Id

integer
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
description
Required

Description

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Locations]
id

Id

integer
companyId

Company Id

integer
locationCode
Required

Location Code

string
description

Description

string
addressTypeId

Address Type Id

string
addressCategoryId

Address Category Id

string
line1
Required

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
stateAssignedCode

State Assigned Code

string
isDefault

Is Default

boolean
county

County

string
isRegistered

Is Registered

boolean
dbaName

Dba Name

string
outletName

Outlet Name

string
effectiveDate

Start Date

string
endDate

End Date

string
lastTransactionDate

Last Transaction Date

string
registeredDate

Registered Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Nexus]
id

id

integer
companyId

companyId

integer
state
Required

state

string
jurisTypeId

jurisTypeId

string
jurisCode
Required

jurisCode

string
jurisName
Required

jurisName

string
effectiveDate

effectiveDate

string
endDate

endDate

string
shortName

shortName

string
signatureCode

signatureCode

string
stateAssignedNo

stateAssignedNo

string
nexusTypeId

nexusTypeId

string
country

country

string
sourcing

sourcing

string
accountingMethodId

accountingMethodId

string
hasLocalNexus

hasLocalNexus

boolean
localNexusTypeId

localNexusTypeId

string
hasPermanentEstablishment

hasPermanentEstablishment

boolean
taxId

taxId

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Settings]
id

Id

integer
companyId

Company Id

integer
set
Required

Set

string
name
Required

Name

string
value

Value

string
Array[TaxCodes]
id

Id

integer
taxCode
Required

Tax Code

string
taxCodeTypeId
Required

Tax Code Type Id

string
companyId

Company Id

integer
description

Description

string
parentTaxCode

Parent Tax Code

string
isPhysical

Is Physical

boolean
goodsServiceCode

Good Service Code

integer
entityUseCode

Entity Use Code

string
isActive

Is Active

boolean
isSSTCertified

Is SST Certified

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[TaxRules]
id

Id

integer
companyId

CompanyId

integer
stateFIPS

State FIPS

string
jurisName

Jurisdiction Name

string
jurisCode
Required

Jurisdiction Code

string
jurisTypeId

Jurisdiction Type Id

string
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
customerUsageType

Customer Usage Type

string
taxTypeId

Tax Type Id

string
rateTypeId

Rate Type Id

string
taxRuleTypeId

Tax Rule Type Id

string
isAllJuris

Is All Juris

boolean
value

Value

number
cap

Cap

number
threshold

Threshold

number
options

Options

string
effectiveDate

Effective Date

string
endDate

End Date

string
description

Description

string
countyFIPS

County FIPS

string
isSTPro

Is STPro

boolean
country
Required

Country

string
region
Required

Region

string
sourcing

Sourcing

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Upcs]
id

Id

integer
companyId

CompanyId

integer
upc
Required

UPC

string
legacyTaxCode

Legacy Tax Code

string
description
Required

Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
usage

Usage

integer
isSystem

IsSystem

integer
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Update a single company now!

Input

Reset

Path Parameters

Post Body

contacts

item 1

Add contacts

filingCalendars

item 1

Add filingCalendars

items

item 1

Add items

locations

item 1

Add locations

nexus

item 1

Add nexus

settings

item 1

Add settings

taxCodes

item 1

Add taxCodes

taxRules

item 1

Add taxRules

upcs

item 1

Add upcs
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{id}
Method
PUT
Request
{
  "contacts": [
    {}
  ],
  "filingCalendars": [
    {}
  ],
  "items": [
    {}
  ],
  "locations": [
    {}
  ],
  "nexus": [
    {}
  ],
  "settings": [
    {}
  ],
  "taxCodes": [
    {}
  ],
  "taxRules": [
    {}
  ],
  "upcs": [
    {}
  ]
}
Response
 

Delete a single company

Deleting a company will delete all child companies, and all users attached to this company.

Api Endpoint
DELETE https://rest-sbx-preview.avalara.net/api/v2/companies/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

id
Required

The ID of the company you wish to delete.

integer

Response

Error
code

Category of the error

string
message

Short one-line message to summaryize what went wrong

string
target

What object or service caused the error?

string
Array[Details]
errorCode

Error message identifier

integer
summary

Concise summary of the message

string
details

Message details

string
faultCode

Indicates the SoapFault code

string
helpLink

URL to help for this message

string
name

Name of the message.

string
refersTo

Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.

string
severity

Severity of the message

string
source

Source of the message

string
documentation

Documentation of the message

string
Try Delete a single company now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{id}
Method
DELETE
Request
curl -X DELETE "https://rest-sbx-preview.avalara.net/api/v2/companies/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve all companies

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$include

A comma separated list of child objects to return underneath the primary object.

string
$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
accountId
Required

Account Id

integer
parentCompanyId

Parent Company Id

integer
sstPid

SST Pid

string
companyCode
Required

Company Code

string
name
Required

Name

string
isDefault

Is Default

boolean
defaultLocationId

Default Location Id

integer
isActive

Is Active

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
taxpayerIdNumber
Required

Tax Payer Id Number

string
hasProfile

Has Profile

boolean
isReportingEntity

Is Reporting Entity

boolean
sstEffectiveDate

SST Effective Date

string
entityNo

Entity No

integer
defaultCountry

Default Country

string
baseCurrencyCode

Base Currency Code

string
roundingLevelId

Rounding Level Id

string
cashBasisAccountingEnabled

Cash Basis Accounting Enabled

boolean
warningsEnabled

Warnings Enabled

boolean
isTest

Is Test

boolean
taxDependencyLevelId

Tax dependency Level Id

string
inProgress

In Progress

boolean
businessIdentificationNo

Business Identification No

string
Array[Contacts]
id

id

integer
companyId

companyId

integer
contactCode
Required

contactCode

string
firstName

firstName

string
middleName

middleName

string
lastName

lastName

string
title

title

string
line1

line1

string
line2

line2

string
line3

line3

string
city

city

string
region

region

string
postalCode

postalCode

string
country

country

string
email

email

string
phone

phone

string
phone2

phone2

string
fax

fax

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[FilingCalendars]
id

Id

integer
companyId

Company Id

integer
returnName
Required

Return Name

string
locationCode

If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.

string
outletTypeId

If this calendar is for a location-specific tax return, specify the location-specific behavior here.

string
paymentCurrency

Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".

string
filingFrequencyId

Filing Frequency Id

string
months

Months

integer
stateRegistrationId
Required

Tax Registration ID for this Region - in the U.S., this is for your state.

string
localRegistrationId

Tax Registration ID for the local jurisdiction, if any.

string
employerIdentificationNumber

Employer Identification Number

string
line1

Line1

string
line2

Line2

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
phone

Phone

string
customerFilingInstructions

Customer Filing Instructions

string
legalEntityName

Legal Entity Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
filingTypeId

Filing Type Id

string
eFileUsername

If you file electronically, this is the username you use to log in to the tax authority's website.

string
eFilePassword

If you file electronically, this is the password or pass code you use to log in to the tax authority's website.

string
prepayPercentage

Prepay Percentage

string
taxTypeId
Required

Tax Type Id

string
internalNotes

Internal Notes

string
alSignOn

Al Sign On

string
alAccessCode

Al Access Code

string
meBusinessCode

Me Business Code

string
iaBen

Ia Ben

string
ctReg

Ct Reg

string
other1Name

Other 1 Name

string
other1Value

Other 1 Value

string
other2Name

Other 2 Name

string
other2Value

Other 2 Value

string
other3Name

Other 3 Name

string
other3Value

Other 3 Value

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Items]
id

Id

integer
itemCode
Required

Item Code

string
companyId

Company Id

integer
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
description
Required

Description

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Locations]
id

Id

integer
companyId

Company Id

integer
locationCode
Required

Location Code

string
description

Description

string
addressTypeId

Address Type Id

string
addressCategoryId

Address Category Id

string
line1
Required

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
stateAssignedCode

State Assigned Code

string
isDefault

Is Default

boolean
county

County

string
isRegistered

Is Registered

boolean
dbaName

Dba Name

string
outletName

Outlet Name

string
effectiveDate

Start Date

string
endDate

End Date

string
lastTransactionDate

Last Transaction Date

string
registeredDate

Registered Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Nexus]
id

id

integer
companyId

companyId

integer
state
Required

state

string
jurisTypeId

jurisTypeId

string
jurisCode
Required

jurisCode

string
jurisName
Required

jurisName

string
effectiveDate

effectiveDate

string
endDate

endDate

string
shortName

shortName

string
signatureCode

signatureCode

string
stateAssignedNo

stateAssignedNo

string
nexusTypeId

nexusTypeId

string
country

country

string
sourcing

sourcing

string
accountingMethodId

accountingMethodId

string
hasLocalNexus

hasLocalNexus

boolean
localNexusTypeId

localNexusTypeId

string
hasPermanentEstablishment

hasPermanentEstablishment

boolean
taxId

taxId

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Settings]
id

Id

integer
companyId

Company Id

integer
set
Required

Set

string
name
Required

Name

string
value

Value

string
Array[TaxCodes]
id

Id

integer
taxCode
Required

Tax Code

string
taxCodeTypeId
Required

Tax Code Type Id

string
companyId

Company Id

integer
description

Description

string
parentTaxCode

Parent Tax Code

string
isPhysical

Is Physical

boolean
goodsServiceCode

Good Service Code

integer
entityUseCode

Entity Use Code

string
isActive

Is Active

boolean
isSSTCertified

Is SST Certified

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[TaxRules]
id

Id

integer
companyId

CompanyId

integer
stateFIPS

State FIPS

string
jurisName

Jurisdiction Name

string
jurisCode
Required

Jurisdiction Code

string
jurisTypeId

Jurisdiction Type Id

string
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
customerUsageType

Customer Usage Type

string
taxTypeId

Tax Type Id

string
rateTypeId

Rate Type Id

string
taxRuleTypeId

Tax Rule Type Id

string
isAllJuris

Is All Juris

boolean
value

Value

number
cap

Cap

number
threshold

Threshold

number
options

Options

string
effectiveDate

Effective Date

string
endDate

End Date

string
description

Description

string
countyFIPS

County FIPS

string
isSTPro

Is STPro

boolean
country
Required

Country

string
region
Required

Region

string
sourcing

Sourcing

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Upcs]
id

Id

integer
companyId

CompanyId

integer
upc
Required

UPC

string
legacyTaxCode

Legacy Tax Code

string
description
Required

Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
usage

Usage

integer
isSystem

IsSystem

integer
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve all companies now!

Input

Reset

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies" -H "Accept: application/json" -H "Authorization: "
Response
 

Create a new company

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/companies

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Post Body Parameters

id

Id

integer
accountId
Required

Account Id

integer
parentCompanyId

Parent Company Id

integer
sstPid

SST Pid

string
companyCode
Required

Company Code

string
name
Required

Name

string
isDefault

Is Default

boolean
defaultLocationId

Default Location Id

integer
isActive

Is Active

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
taxpayerIdNumber
Required

Tax Payer Id Number

string
hasProfile

Has Profile

boolean
isReportingEntity

Is Reporting Entity

boolean
sstEffectiveDate

SST Effective Date

string
entityNo

Entity No

integer
defaultCountry

Default Country

string
baseCurrencyCode

Base Currency Code

string
roundingLevelId

Rounding Level Id

string
cashBasisAccountingEnabled

Cash Basis Accounting Enabled

boolean
warningsEnabled

Warnings Enabled

boolean
isTest

Is Test

boolean
taxDependencyLevelId

Tax dependency Level Id

string
inProgress

In Progress

boolean
businessIdentificationNo

Business Identification No

string
Array[Contacts]
id

id

integer
companyId

companyId

integer
contactCode
Required

contactCode

string
firstName

firstName

string
middleName

middleName

string
lastName

lastName

string
title

title

string
line1

line1

string
line2

line2

string
line3

line3

string
city

city

string
region

region

string
postalCode

postalCode

string
country

country

string
email

email

string
phone

phone

string
phone2

phone2

string
fax

fax

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[FilingCalendars]
id

Id

integer
companyId

Company Id

integer
returnName
Required

Return Name

string
locationCode

If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.

string
outletTypeId

If this calendar is for a location-specific tax return, specify the location-specific behavior here.

string
paymentCurrency

Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".

string
filingFrequencyId

Filing Frequency Id

string
months

Months

integer
stateRegistrationId
Required

Tax Registration ID for this Region - in the U.S., this is for your state.

string
localRegistrationId

Tax Registration ID for the local jurisdiction, if any.

string
employerIdentificationNumber

Employer Identification Number

string
line1

Line1

string
line2

Line2

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
phone

Phone

string
customerFilingInstructions

Customer Filing Instructions

string
legalEntityName

Legal Entity Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
filingTypeId

Filing Type Id

string
eFileUsername

If you file electronically, this is the username you use to log in to the tax authority's website.

string
eFilePassword

If you file electronically, this is the password or pass code you use to log in to the tax authority's website.

string
prepayPercentage

Prepay Percentage

string
taxTypeId
Required

Tax Type Id

string
internalNotes

Internal Notes

string
alSignOn

Al Sign On

string
alAccessCode

Al Access Code

string
meBusinessCode

Me Business Code

string
iaBen

Ia Ben

string
ctReg

Ct Reg

string
other1Name

Other 1 Name

string
other1Value

Other 1 Value

string
other2Name

Other 2 Name

string
other2Value

Other 2 Value

string
other3Name

Other 3 Name

string
other3Value

Other 3 Value

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Items]
id

Id

integer
itemCode
Required

Item Code

string
companyId

Company Id

integer
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
description
Required

Description

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Locations]
id

Id

integer
companyId

Company Id

integer
locationCode
Required

Location Code

string
description

Description

string
addressTypeId

Address Type Id

string
addressCategoryId

Address Category Id

string
line1
Required

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
stateAssignedCode

State Assigned Code

string
isDefault

Is Default

boolean
county

County

string
isRegistered

Is Registered

boolean
dbaName

Dba Name

string
outletName

Outlet Name

string
effectiveDate

Start Date

string
endDate

End Date

string
lastTransactionDate

Last Transaction Date

string
registeredDate

Registered Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Nexus]
id

id

integer
companyId

companyId

integer
state
Required

state

string
jurisTypeId

jurisTypeId

string
jurisCode
Required

jurisCode

string
jurisName
Required

jurisName

string
effectiveDate

effectiveDate

string
endDate

endDate

string
shortName

shortName

string
signatureCode

signatureCode

string
stateAssignedNo

stateAssignedNo

string
nexusTypeId

nexusTypeId

string
country

country

string
sourcing

sourcing

string
accountingMethodId

accountingMethodId

string
hasLocalNexus

hasLocalNexus

boolean
localNexusTypeId

localNexusTypeId

string
hasPermanentEstablishment

hasPermanentEstablishment

boolean
taxId

taxId

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Settings]
id

Id

integer
companyId

Company Id

integer
set
Required

Set

string
name
Required

Name

string
value

Value

string
Array[TaxCodes]
id

Id

integer
taxCode
Required

Tax Code

string
taxCodeTypeId
Required

Tax Code Type Id

string
companyId

Company Id

integer
description

Description

string
parentTaxCode

Parent Tax Code

string
isPhysical

Is Physical

boolean
goodsServiceCode

Good Service Code

integer
entityUseCode

Entity Use Code

string
isActive

Is Active

boolean
isSSTCertified

Is SST Certified

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[TaxRules]
id

Id

integer
companyId

CompanyId

integer
stateFIPS

State FIPS

string
jurisName

Jurisdiction Name

string
jurisCode
Required

Jurisdiction Code

string
jurisTypeId

Jurisdiction Type Id

string
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
customerUsageType

Customer Usage Type

string
taxTypeId

Tax Type Id

string
rateTypeId

Rate Type Id

string
taxRuleTypeId

Tax Rule Type Id

string
isAllJuris

Is All Juris

boolean
value

Value

number
cap

Cap

number
threshold

Threshold

number
options

Options

string
effectiveDate

Effective Date

string
endDate

End Date

string
description

Description

string
countyFIPS

County FIPS

string
isSTPro

Is STPro

boolean
country
Required

Country

string
region
Required

Region

string
sourcing

Sourcing

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Upcs]
id

Id

integer
companyId

CompanyId

integer
upc
Required

UPC

string
legacyTaxCode

Legacy Tax Code

string
description
Required

Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
usage

Usage

integer
isSystem

IsSystem

integer
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response

id

Id

integer
accountId
Required

Account Id

integer
parentCompanyId

Parent Company Id

integer
sstPid

SST Pid

string
companyCode
Required

Company Code

string
name
Required

Name

string
isDefault

Is Default

boolean
defaultLocationId

Default Location Id

integer
isActive

Is Active

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
taxpayerIdNumber
Required

Tax Payer Id Number

string
hasProfile

Has Profile

boolean
isReportingEntity

Is Reporting Entity

boolean
sstEffectiveDate

SST Effective Date

string
entityNo

Entity No

integer
defaultCountry

Default Country

string
baseCurrencyCode

Base Currency Code

string
roundingLevelId

Rounding Level Id

string
cashBasisAccountingEnabled

Cash Basis Accounting Enabled

boolean
warningsEnabled

Warnings Enabled

boolean
isTest

Is Test

boolean
taxDependencyLevelId

Tax dependency Level Id

string
inProgress

In Progress

boolean
businessIdentificationNo

Business Identification No

string
Array[Contacts]
id

id

integer
companyId

companyId

integer
contactCode
Required

contactCode

string
firstName

firstName

string
middleName

middleName

string
lastName

lastName

string
title

title

string
line1

line1

string
line2

line2

string
line3

line3

string
city

city

string
region

region

string
postalCode

postalCode

string
country

country

string
email

email

string
phone

phone

string
phone2

phone2

string
fax

fax

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[FilingCalendars]
id

Id

integer
companyId

Company Id

integer
returnName
Required

Return Name

string
locationCode

If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.

string
outletTypeId

If this calendar is for a location-specific tax return, specify the location-specific behavior here.

string
paymentCurrency

Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".

string
filingFrequencyId

Filing Frequency Id

string
months

Months

integer
stateRegistrationId
Required

Tax Registration ID for this Region - in the U.S., this is for your state.

string
localRegistrationId

Tax Registration ID for the local jurisdiction, if any.

string
employerIdentificationNumber

Employer Identification Number

string
line1

Line1

string
line2

Line2

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
phone

Phone

string
customerFilingInstructions

Customer Filing Instructions

string
legalEntityName

Legal Entity Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
filingTypeId

Filing Type Id

string
eFileUsername

If you file electronically, this is the username you use to log in to the tax authority's website.

string
eFilePassword

If you file electronically, this is the password or pass code you use to log in to the tax authority's website.

string
prepayPercentage

Prepay Percentage

string
taxTypeId
Required

Tax Type Id

string
internalNotes

Internal Notes

string
alSignOn

Al Sign On

string
alAccessCode

Al Access Code

string
meBusinessCode

Me Business Code

string
iaBen

Ia Ben

string
ctReg

Ct Reg

string
other1Name

Other 1 Name

string
other1Value

Other 1 Value

string
other2Name

Other 2 Name

string
other2Value

Other 2 Value

string
other3Name

Other 3 Name

string
other3Value

Other 3 Value

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Items]
id

Id

integer
itemCode
Required

Item Code

string
companyId

Company Id

integer
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
description
Required

Description

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Locations]
id

Id

integer
companyId

Company Id

integer
locationCode
Required

Location Code

string
description

Description

string
addressTypeId

Address Type Id

string
addressCategoryId

Address Category Id

string
line1
Required

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
stateAssignedCode

State Assigned Code

string
isDefault

Is Default

boolean
county

County

string
isRegistered

Is Registered

boolean
dbaName

Dba Name

string
outletName

Outlet Name

string
effectiveDate

Start Date

string
endDate

End Date

string
lastTransactionDate

Last Transaction Date

string
registeredDate

Registered Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Nexus]
id

id

integer
companyId

companyId

integer
state
Required

state

string
jurisTypeId

jurisTypeId

string
jurisCode
Required

jurisCode

string
jurisName
Required

jurisName

string
effectiveDate

effectiveDate

string
endDate

endDate

string
shortName

shortName

string
signatureCode

signatureCode

string
stateAssignedNo

stateAssignedNo

string
nexusTypeId

nexusTypeId

string
country

country

string
sourcing

sourcing

string
accountingMethodId

accountingMethodId

string
hasLocalNexus

hasLocalNexus

boolean
localNexusTypeId

localNexusTypeId

string
hasPermanentEstablishment

hasPermanentEstablishment

boolean
taxId

taxId

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Settings]
id

Id

integer
companyId

Company Id

integer
set
Required

Set

string
name
Required

Name

string
value

Value

string
Array[TaxCodes]
id

Id

integer
taxCode
Required

Tax Code

string
taxCodeTypeId
Required

Tax Code Type Id

string
companyId

Company Id

integer
description

Description

string
parentTaxCode

Parent Tax Code

string
isPhysical

Is Physical

boolean
goodsServiceCode

Good Service Code

integer
entityUseCode

Entity Use Code

string
isActive

Is Active

boolean
isSSTCertified

Is SST Certified

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[TaxRules]
id

Id

integer
companyId

CompanyId

integer
stateFIPS

State FIPS

string
jurisName

Jurisdiction Name

string
jurisCode
Required

Jurisdiction Code

string
jurisTypeId

Jurisdiction Type Id

string
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
customerUsageType

Customer Usage Type

string
taxTypeId

Tax Type Id

string
rateTypeId

Rate Type Id

string
taxRuleTypeId

Tax Rule Type Id

string
isAllJuris

Is All Juris

boolean
value

Value

number
cap

Cap

number
threshold

Threshold

number
options

Options

string
effectiveDate

Effective Date

string
endDate

End Date

string
description

Description

string
countyFIPS

County FIPS

string
isSTPro

Is STPro

boolean
country
Required

Country

string
region
Required

Region

string
sourcing

Sourcing

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Upcs]
id

Id

integer
companyId

CompanyId

integer
upc
Required

UPC

string
legacyTaxCode

Legacy Tax Code

string
description
Required

Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
usage

Usage

integer
isSystem

IsSystem

integer
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Create a new company now!

Input

Reset

Post Body

contacts

item 1

Add contacts

filingCalendars

item 1

Add filingCalendars

items

item 1

Add items

locations

item 1

Add locations

nexus

item 1

Add nexus

settings

item 1

Add settings

taxCodes

item 1

Add taxCodes

taxRules

item 1

Add taxRules

upcs

item 1

Add upcs
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies
Method
POST
Request
{
  "contacts": [
    {}
  ],
  "filingCalendars": [
    {}
  ],
  "items": [
    {}
  ],
  "locations": [
    {}
  ],
  "nexus": [
    {}
  ],
  "settings": [
    {}
  ],
  "taxCodes": [
    {}
  ],
  "taxRules": [
    {}
  ],
  "upcs": [
    {}
  ]
}
Response
 

Quick setup for a company with a single physical address

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/companies/initialize

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Post Body Parameters

name
Required

Company Name

string
companyCode
Required

Company Code - used to distinguish between companies within your accounting system

string
vatRegistrationId

Vat Registration Id - leave blank if not known.

string
taxpayerIdNumber

United States Taxpayer ID number, usually your Employer Identification Number if you are a business or your Social Security Number if you are an individual.

string
line1
Required

Address Line1

string
line2

Line2

string
line3

Line3

string
city
Required

City

string
region
Required

Region

string
postalCode
Required

Postal Code

string
country
Required

Country

string
firstName
Required

First Name

string
lastName
Required

Last Name

string
title

Title

string
email
Required

Email

string
phoneNumber
Required

Phone Number

string
mobileNumber

Mobile Number

string
faxNumber

Fax Number

string

Response

id

Id

integer
accountId
Required

Account Id

integer
parentCompanyId

Parent Company Id

integer
sstPid

SST Pid

string
companyCode
Required

Company Code

string
name
Required

Name

string
isDefault

Is Default

boolean
defaultLocationId

Default Location Id

integer
isActive

Is Active

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
taxpayerIdNumber
Required

Tax Payer Id Number

string
hasProfile

Has Profile

boolean
isReportingEntity

Is Reporting Entity

boolean
sstEffectiveDate

SST Effective Date

string
entityNo

Entity No

integer
defaultCountry

Default Country

string
baseCurrencyCode

Base Currency Code

string
roundingLevelId

Rounding Level Id

string
cashBasisAccountingEnabled

Cash Basis Accounting Enabled

boolean
warningsEnabled

Warnings Enabled

boolean
isTest

Is Test

boolean
taxDependencyLevelId

Tax dependency Level Id

string
inProgress

In Progress

boolean
businessIdentificationNo

Business Identification No

string
Array[Contacts]
id

id

integer
companyId

companyId

integer
contactCode
Required

contactCode

string
firstName

firstName

string
middleName

middleName

string
lastName

lastName

string
title

title

string
line1

line1

string
line2

line2

string
line3

line3

string
city

city

string
region

region

string
postalCode

postalCode

string
country

country

string
email

email

string
phone

phone

string
phone2

phone2

string
fax

fax

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[FilingCalendars]
id

Id

integer
companyId

Company Id

integer
returnName
Required

Return Name

string
locationCode

If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.

string
outletTypeId

If this calendar is for a location-specific tax return, specify the location-specific behavior here.

string
paymentCurrency

Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".

string
filingFrequencyId

Filing Frequency Id

string
months

Months

integer
stateRegistrationId
Required

Tax Registration ID for this Region - in the U.S., this is for your state.

string
localRegistrationId

Tax Registration ID for the local jurisdiction, if any.

string
employerIdentificationNumber

Employer Identification Number

string
line1

Line1

string
line2

Line2

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
phone

Phone

string
customerFilingInstructions

Customer Filing Instructions

string
legalEntityName

Legal Entity Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
filingTypeId

Filing Type Id

string
eFileUsername

If you file electronically, this is the username you use to log in to the tax authority's website.

string
eFilePassword

If you file electronically, this is the password or pass code you use to log in to the tax authority's website.

string
prepayPercentage

Prepay Percentage

string
taxTypeId
Required

Tax Type Id

string
internalNotes

Internal Notes

string
alSignOn

Al Sign On

string
alAccessCode

Al Access Code

string
meBusinessCode

Me Business Code

string
iaBen

Ia Ben

string
ctReg

Ct Reg

string
other1Name

Other 1 Name

string
other1Value

Other 1 Value

string
other2Name

Other 2 Name

string
other2Value

Other 2 Value

string
other3Name

Other 3 Name

string
other3Value

Other 3 Value

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Items]
id

Id

integer
itemCode
Required

Item Code

string
companyId

Company Id

integer
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
description
Required

Description

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Locations]
id

Id

integer
companyId

Company Id

integer
locationCode
Required

Location Code

string
description

Description

string
addressTypeId

Address Type Id

string
addressCategoryId

Address Category Id

string
line1
Required

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
stateAssignedCode

State Assigned Code

string
isDefault

Is Default

boolean
county

County

string
isRegistered

Is Registered

boolean
dbaName

Dba Name

string
outletName

Outlet Name

string
effectiveDate

Start Date

string
endDate

End Date

string
lastTransactionDate

Last Transaction Date

string
registeredDate

Registered Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Nexus]
id

id

integer
companyId

companyId

integer
state
Required

state

string
jurisTypeId

jurisTypeId

string
jurisCode
Required

jurisCode

string
jurisName
Required

jurisName

string
effectiveDate

effectiveDate

string
endDate

endDate

string
shortName

shortName

string
signatureCode

signatureCode

string
stateAssignedNo

stateAssignedNo

string
nexusTypeId

nexusTypeId

string
country

country

string
sourcing

sourcing

string
accountingMethodId

accountingMethodId

string
hasLocalNexus

hasLocalNexus

boolean
localNexusTypeId

localNexusTypeId

string
hasPermanentEstablishment

hasPermanentEstablishment

boolean
taxId

taxId

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Settings]
id

Id

integer
companyId

Company Id

integer
set
Required

Set

string
name
Required

Name

string
value

Value

string
Array[TaxCodes]
id

Id

integer
taxCode
Required

Tax Code

string
taxCodeTypeId
Required

Tax Code Type Id

string
companyId

Company Id

integer
description

Description

string
parentTaxCode

Parent Tax Code

string
isPhysical

Is Physical

boolean
goodsServiceCode

Good Service Code

integer
entityUseCode

Entity Use Code

string
isActive

Is Active

boolean
isSSTCertified

Is SST Certified

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[TaxRules]
id

Id

integer
companyId

CompanyId

integer
stateFIPS

State FIPS

string
jurisName

Jurisdiction Name

string
jurisCode
Required

Jurisdiction Code

string
jurisTypeId

Jurisdiction Type Id

string
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
customerUsageType

Customer Usage Type

string
taxTypeId

Tax Type Id

string
rateTypeId

Rate Type Id

string
taxRuleTypeId

Tax Rule Type Id

string
isAllJuris

Is All Juris

boolean
value

Value

number
cap

Cap

number
threshold

Threshold

number
options

Options

string
effectiveDate

Effective Date

string
endDate

End Date

string
description

Description

string
countyFIPS

County FIPS

string
isSTPro

Is STPro

boolean
country
Required

Country

string
region
Required

Region

string
sourcing

Sourcing

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Upcs]
id

Id

integer
companyId

CompanyId

integer
upc
Required

UPC

string
legacyTaxCode

Legacy Tax Code

string
description
Required

Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
usage

Usage

integer
isSystem

IsSystem

integer
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Quick setup for a company with a single physical address now!

Input

Reset

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/initialize
Method
POST
Request
{}
Response
 

Retrieve a single contact

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/contacts/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this contact

integer
id
Required

The primary key of this contact

integer

Response

id

id

integer
companyId

companyId

integer
contactCode
Required

contactCode

string
firstName

firstName

string
middleName

middleName

string
lastName

lastName

string
title

title

string
line1

line1

string
line2

line2

string
line3

line3

string
city

city

string
region

region

string
postalCode

postalCode

string
country

country

string
email

email

string
phone

phone

string
phone2

phone2

string
fax

fax

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Retrieve a single contact now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/contacts/{id}
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/contacts/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Update a single contact

Api Endpoint
PUT https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/contacts/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that this contact belongs to.

integer
id
Required

The ID of the contact you wish to update

integer

Post Body Parameters

id

id

integer
companyId

companyId

integer
contactCode
Required

contactCode

string
firstName

firstName

string
middleName

middleName

string
lastName

lastName

string
title

title

string
line1

line1

string
line2

line2

string
line3

line3

string
city

city

string
region

region

string
postalCode

postalCode

string
country

country

string
email

email

string
phone

phone

string
phone2

phone2

string
fax

fax

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response

id

id

integer
companyId

companyId

integer
contactCode
Required

contactCode

string
firstName

firstName

string
middleName

middleName

string
lastName

lastName

string
title

title

string
line1

line1

string
line2

line2

string
line3

line3

string
city

city

string
region

region

string
postalCode

postalCode

string
country

country

string
email

email

string
phone

phone

string
phone2

phone2

string
fax

fax

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Update a single contact now!

Input

Reset

Path Parameters

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/contacts/{id}
Method
PUT
Request
{}
Response
 

Delete a single contact

Api Endpoint
DELETE https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/contacts/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this contact.

integer
id
Required

The ID of the contact you wish to delete.

integer

Response

Error
code

Category of the error

string
message

Short one-line message to summaryize what went wrong

string
target

What object or service caused the error?

string
Array[Details]
errorCode

Error message identifier

integer
summary

Concise summary of the message

string
details

Message details

string
faultCode

Indicates the SoapFault code

string
helpLink

URL to help for this message

string
name

Name of the message.

string
refersTo

Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.

string
severity

Severity of the message

string
source

Source of the message

string
documentation

Documentation of the message

string
Try Delete a single contact now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/contacts/{id}
Method
DELETE
Request
curl -X DELETE "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/contacts/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve contacts for this company

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/contacts

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Path Parameters

companyId
Required

The ID of the company that owns these contacts

integer

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

id

integer
companyId

companyId

integer
contactCode
Required

contactCode

string
firstName

firstName

string
middleName

middleName

string
lastName

lastName

string
title

title

string
line1

line1

string
line2

line2

string
line3

line3

string
city

city

string
region

region

string
postalCode

postalCode

string
country

country

string
email

email

string
phone

phone

string
phone2

phone2

string
fax

fax

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve contacts for this company now!

Input

Reset

Path Parameters

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/contacts
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/contacts" -H "Accept: application/json" -H "Authorization: "
Response
 

Create a new contact

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/contacts

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this contact.

integer

Post Body Parameters[Array]

id

id

integer
companyId

companyId

integer
contactCode
Required

contactCode

string
firstName

firstName

string
middleName

middleName

string
lastName

lastName

string
title

title

string
line1

line1

string
line2

line2

string
line3

line3

string
city

city

string
region

region

string
postalCode

postalCode

string
country

country

string
email

email

string
phone

phone

string
phone2

phone2

string
fax

fax

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response[Array]

id

id

integer
companyId

companyId

integer
contactCode
Required

contactCode

string
firstName

firstName

string
middleName

middleName

string
lastName

lastName

string
title

title

string
line1

line1

string
line2

line2

string
line3

line3

string
city

city

string
region

region

string
postalCode

postalCode

string
country

country

string
email

email

string
phone

phone

string
phone2

phone2

string
fax

fax

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Create a new contact now!

Input

Reset

Path Parameters

Post Body

item 1

Add Item
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/contacts
Method
POST
Request
[
  {}
]
Response
 

Retrieve all contacts

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/contacts

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

id

integer
companyId

companyId

integer
contactCode
Required

contactCode

string
firstName

firstName

string
middleName

middleName

string
lastName

lastName

string
title

title

string
line1

line1

string
line2

line2

string
line3

line3

string
city

city

string
region

region

string
postalCode

postalCode

string
country

country

string
email

email

string
phone

phone

string
phone2

phone2

string
fax

fax

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve all contacts now!

Input

Reset

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/contacts
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/contacts" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve the full list of Avalara-supported nexus for all countries and regions.

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/definitions/nexus

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

id

integer
companyId

companyId

integer
state
Required

state

string
jurisTypeId

jurisTypeId

string
jurisCode
Required

jurisCode

string
jurisName
Required

jurisName

string
effectiveDate

effectiveDate

string
endDate

endDate

string
shortName

shortName

string
signatureCode

signatureCode

string
stateAssignedNo

stateAssignedNo

string
nexusTypeId

nexusTypeId

string
country

country

string
sourcing

sourcing

string
accountingMethodId

accountingMethodId

string
hasLocalNexus

hasLocalNexus

boolean
localNexusTypeId

localNexusTypeId

string
hasPermanentEstablishment

hasPermanentEstablishment

boolean
taxId

taxId

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve the full list of Avalara-supported nexus for all countries and regions. now!

Input

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/definitions/nexus
Method
GET
Response
 

Retrieve the full list of Avalara-supported nexus for a country.

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/definitions/nexus/{country}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

country
Required
string

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

id

integer
companyId

companyId

integer
state
Required

state

string
jurisTypeId

jurisTypeId

string
jurisCode
Required

jurisCode

string
jurisName
Required

jurisName

string
effectiveDate

effectiveDate

string
endDate

endDate

string
shortName

shortName

string
signatureCode

signatureCode

string
stateAssignedNo

stateAssignedNo

string
nexusTypeId

nexusTypeId

string
country

country

string
sourcing

sourcing

string
accountingMethodId

accountingMethodId

string
hasLocalNexus

hasLocalNexus

boolean
localNexusTypeId

localNexusTypeId

string
hasPermanentEstablishment

hasPermanentEstablishment

boolean
taxId

taxId

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve the full list of Avalara-supported nexus for a country. now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/definitions/nexus/{country}
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/definitions/nexus/{country}" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve the full list of Avalara-supported nexus for a country and region.

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/definitions/nexus/{country}/{region}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

country
Required

The two-character ISO-3166 code for the country.

string
region
Required

The two or three character region code for the region.

string

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

id

integer
companyId

companyId

integer
state
Required

state

string
jurisTypeId

jurisTypeId

string
jurisCode
Required

jurisCode

string
jurisName
Required

jurisName

string
effectiveDate

effectiveDate

string
endDate

endDate

string
shortName

shortName

string
signatureCode

signatureCode

string
stateAssignedNo

stateAssignedNo

string
nexusTypeId

nexusTypeId

string
country

country

string
sourcing

sourcing

string
accountingMethodId

accountingMethodId

string
hasLocalNexus

hasLocalNexus

boolean
localNexusTypeId

localNexusTypeId

string
hasPermanentEstablishment

hasPermanentEstablishment

boolean
taxId

taxId

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve the full list of Avalara-supported nexus for a country and region. now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/definitions/nexus/{country}/{region}
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/definitions/nexus/{country}/{region}" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve the full list of Avalara-supported tax codes.

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/definitions/taxcodes

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
taxCode
Required

Tax Code

string
taxCodeTypeId
Required

Tax Code Type Id

string
companyId

Company Id

integer
description

Description

string
parentTaxCode

Parent Tax Code

string
isPhysical

Is Physical

boolean
goodsServiceCode

Good Service Code

integer
entityUseCode

Entity Use Code

string
isActive

Is Active

boolean
isSSTCertified

Is SST Certified

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve the full list of Avalara-supported tax codes. now!

Input

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/definitions/taxcodes
Method
GET
Response
 

Retrieve the full list of Avalara-supported subscription types

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/definitions/subscriptiontypes

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
description
Required

Description

string
@nextLink

The link to the next page of results

string
Try Retrieve the full list of Avalara-supported subscription types now!

Input

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/definitions/subscriptiontypes
Method
GET
Response
 

Retrieve the full list of Avalara-supported tax authorities.

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/definitions/taxauthorities

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
name
Required

Name

string
taxAuthorityTypeId

Tax Authority Type Id

integer
jurisdictionId

Jurisdiction Id

integer
@nextLink

The link to the next page of results

string
Try Retrieve the full list of Avalara-supported tax authorities. now!

Input

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/definitions/taxauthorities
Method
GET
Response
 

Retrieve the full list of Avalara-supported tax authorities.

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/definitions/taxauthorityforms

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
taxAuthorityId

Tax Authority Id

integer
formName
Required

Form Name

string
@nextLink

The link to the next page of results

string
Try Retrieve the full list of Avalara-supported tax authorities. now!

Input

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/definitions/taxauthorityforms
Method
GET
Response
 

Retrieve a single filing calendar

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/filingcalendars/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this filing calendar

integer
id
Required

The primary key of this filing calendar

integer

Response

id

Id

integer
companyId

Company Id

integer
returnName
Required

Return Name

string
locationCode

If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.

string
outletTypeId

If this calendar is for a location-specific tax return, specify the location-specific behavior here.

string
paymentCurrency

Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".

string
filingFrequencyId

Filing Frequency Id

string
months

Months

integer
stateRegistrationId
Required

Tax Registration ID for this Region - in the U.S., this is for your state.

string
localRegistrationId

Tax Registration ID for the local jurisdiction, if any.

string
employerIdentificationNumber

Employer Identification Number

string
line1

Line1

string
line2

Line2

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
phone

Phone

string
customerFilingInstructions

Customer Filing Instructions

string
legalEntityName

Legal Entity Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
filingTypeId

Filing Type Id

string
eFileUsername

If you file electronically, this is the username you use to log in to the tax authority's website.

string
eFilePassword

If you file electronically, this is the password or pass code you use to log in to the tax authority's website.

string
prepayPercentage

Prepay Percentage

string
taxTypeId
Required

Tax Type Id

string
internalNotes

Internal Notes

string
alSignOn

Al Sign On

string
alAccessCode

Al Access Code

string
meBusinessCode

Me Business Code

string
iaBen

Ia Ben

string
ctReg

Ct Reg

string
other1Name

Other 1 Name

string
other1Value

Other 1 Value

string
other2Name

Other 2 Name

string
other2Value

Other 2 Value

string
other3Name

Other 3 Name

string
other3Value

Other 3 Value

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Retrieve a single filing calendar now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/filingcalendars/{id}
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/filingcalendars/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Update a single filing calendar

Api Endpoint
PUT https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/filingcalendars/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that this filing calendar belongs to.

integer
id
Required

The ID of the filing calendar you wish to update

integer

Post Body Parameters

id

Id

integer
companyId

Company Id

integer
returnName
Required

Return Name

string
locationCode

If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.

string
outletTypeId

If this calendar is for a location-specific tax return, specify the location-specific behavior here.

string
paymentCurrency

Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".

string
filingFrequencyId

Filing Frequency Id

string
months

Months

integer
stateRegistrationId
Required

Tax Registration ID for this Region - in the U.S., this is for your state.

string
localRegistrationId

Tax Registration ID for the local jurisdiction, if any.

string
employerIdentificationNumber

Employer Identification Number

string
line1

Line1

string
line2

Line2

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
phone

Phone

string
customerFilingInstructions

Customer Filing Instructions

string
legalEntityName

Legal Entity Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
filingTypeId

Filing Type Id

string
eFileUsername

If you file electronically, this is the username you use to log in to the tax authority's website.

string
eFilePassword

If you file electronically, this is the password or pass code you use to log in to the tax authority's website.

string
prepayPercentage

Prepay Percentage

string
taxTypeId
Required

Tax Type Id

string
internalNotes

Internal Notes

string
alSignOn

Al Sign On

string
alAccessCode

Al Access Code

string
meBusinessCode

Me Business Code

string
iaBen

Ia Ben

string
ctReg

Ct Reg

string
other1Name

Other 1 Name

string
other1Value

Other 1 Value

string
other2Name

Other 2 Name

string
other2Value

Other 2 Value

string
other3Name

Other 3 Name

string
other3Value

Other 3 Value

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response

id

Id

integer
companyId

Company Id

integer
returnName
Required

Return Name

string
locationCode

If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.

string
outletTypeId

If this calendar is for a location-specific tax return, specify the location-specific behavior here.

string
paymentCurrency

Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".

string
filingFrequencyId

Filing Frequency Id

string
months

Months

integer
stateRegistrationId
Required

Tax Registration ID for this Region - in the U.S., this is for your state.

string
localRegistrationId

Tax Registration ID for the local jurisdiction, if any.

string
employerIdentificationNumber

Employer Identification Number

string
line1

Line1

string
line2

Line2

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
phone

Phone

string
customerFilingInstructions

Customer Filing Instructions

string
legalEntityName

Legal Entity Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
filingTypeId

Filing Type Id

string
eFileUsername

If you file electronically, this is the username you use to log in to the tax authority's website.

string
eFilePassword

If you file electronically, this is the password or pass code you use to log in to the tax authority's website.

string
prepayPercentage

Prepay Percentage

string
taxTypeId
Required

Tax Type Id

string
internalNotes

Internal Notes

string
alSignOn

Al Sign On

string
alAccessCode

Al Access Code

string
meBusinessCode

Me Business Code

string
iaBen

Ia Ben

string
ctReg

Ct Reg

string
other1Name

Other 1 Name

string
other1Value

Other 1 Value

string
other2Name

Other 2 Name

string
other2Value

Other 2 Value

string
other3Name

Other 3 Name

string
other3Value

Other 3 Value

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Update a single filing calendar now!

Input

Reset

Path Parameters

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/filingcalendars/{id}
Method
PUT
Request
{}
Response
 

Delete a single filing calendar

Api Endpoint
DELETE https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/filingcalendars/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this filing calendar.

integer
id
Required

The ID of the filing calendar you wish to delete.

integer

Response

Error
code

Category of the error

string
message

Short one-line message to summaryize what went wrong

string
target

What object or service caused the error?

string
Array[Details]
errorCode

Error message identifier

integer
summary

Concise summary of the message

string
details

Message details

string
faultCode

Indicates the SoapFault code

string
helpLink

URL to help for this message

string
name

Name of the message.

string
refersTo

Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.

string
severity

Severity of the message

string
source

Source of the message

string
documentation

Documentation of the message

string
Try Delete a single filing calendar now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/filingcalendars/{id}
Method
DELETE
Request
curl -X DELETE "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/filingcalendars/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve filing calendars for this company

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/filingcalendars

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Path Parameters

companyId
Required

The ID of the company that owns these filing calendars

integer

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
companyId

Company Id

integer
returnName
Required

Return Name

string
locationCode

If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.

string
outletTypeId

If this calendar is for a location-specific tax return, specify the location-specific behavior here.

string
paymentCurrency

Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".

string
filingFrequencyId

Filing Frequency Id

string
months

Months

integer
stateRegistrationId
Required

Tax Registration ID for this Region - in the U.S., this is for your state.

string
localRegistrationId

Tax Registration ID for the local jurisdiction, if any.

string
employerIdentificationNumber

Employer Identification Number

string
line1

Line1

string
line2

Line2

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
phone

Phone

string
customerFilingInstructions

Customer Filing Instructions

string
legalEntityName

Legal Entity Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
filingTypeId

Filing Type Id

string
eFileUsername

If you file electronically, this is the username you use to log in to the tax authority's website.

string
eFilePassword

If you file electronically, this is the password or pass code you use to log in to the tax authority's website.

string
prepayPercentage

Prepay Percentage

string
taxTypeId
Required

Tax Type Id

string
internalNotes

Internal Notes

string
alSignOn

Al Sign On

string
alAccessCode

Al Access Code

string
meBusinessCode

Me Business Code

string
iaBen

Ia Ben

string
ctReg

Ct Reg

string
other1Name

Other 1 Name

string
other1Value

Other 1 Value

string
other2Name

Other 2 Name

string
other2Value

Other 2 Value

string
other3Name

Other 3 Name

string
other3Value

Other 3 Value

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve filing calendars for this company now!

Input

Reset

Path Parameters

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/filingcalendars
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/filingcalendars" -H "Accept: application/json" -H "Authorization: "
Response
 

Create a new filing calendar

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/filingcalendars

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this filing calendar.

integer

Post Body Parameters[Array]

id

Id

integer
companyId

Company Id

integer
returnName
Required

Return Name

string
locationCode

If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.

string
outletTypeId

If this calendar is for a location-specific tax return, specify the location-specific behavior here.

string
paymentCurrency

Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".

string
filingFrequencyId

Filing Frequency Id

string
months

Months

integer
stateRegistrationId
Required

Tax Registration ID for this Region - in the U.S., this is for your state.

string
localRegistrationId

Tax Registration ID for the local jurisdiction, if any.

string
employerIdentificationNumber

Employer Identification Number

string
line1

Line1

string
line2

Line2

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
phone

Phone

string
customerFilingInstructions

Customer Filing Instructions

string
legalEntityName

Legal Entity Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
filingTypeId

Filing Type Id

string
eFileUsername

If you file electronically, this is the username you use to log in to the tax authority's website.

string
eFilePassword

If you file electronically, this is the password or pass code you use to log in to the tax authority's website.

string
prepayPercentage

Prepay Percentage

string
taxTypeId
Required

Tax Type Id

string
internalNotes

Internal Notes

string
alSignOn

Al Sign On

string
alAccessCode

Al Access Code

string
meBusinessCode

Me Business Code

string
iaBen

Ia Ben

string
ctReg

Ct Reg

string
other1Name

Other 1 Name

string
other1Value

Other 1 Value

string
other2Name

Other 2 Name

string
other2Value

Other 2 Value

string
other3Name

Other 3 Name

string
other3Value

Other 3 Value

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response[Array]

id

Id

integer
companyId

Company Id

integer
returnName
Required

Return Name

string
locationCode

If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.

string
outletTypeId

If this calendar is for a location-specific tax return, specify the location-specific behavior here.

string
paymentCurrency

Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".

string
filingFrequencyId

Filing Frequency Id

string
months

Months

integer
stateRegistrationId
Required

Tax Registration ID for this Region - in the U.S., this is for your state.

string
localRegistrationId

Tax Registration ID for the local jurisdiction, if any.

string
employerIdentificationNumber

Employer Identification Number

string
line1

Line1

string
line2

Line2

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
phone

Phone

string
customerFilingInstructions

Customer Filing Instructions

string
legalEntityName

Legal Entity Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
filingTypeId

Filing Type Id

string
eFileUsername

If you file electronically, this is the username you use to log in to the tax authority's website.

string
eFilePassword

If you file electronically, this is the password or pass code you use to log in to the tax authority's website.

string
prepayPercentage

Prepay Percentage

string
taxTypeId
Required

Tax Type Id

string
internalNotes

Internal Notes

string
alSignOn

Al Sign On

string
alAccessCode

Al Access Code

string
meBusinessCode

Me Business Code

string
iaBen

Ia Ben

string
ctReg

Ct Reg

string
other1Name

Other 1 Name

string
other1Value

Other 1 Value

string
other2Name

Other 2 Name

string
other2Value

Other 2 Value

string
other3Name

Other 3 Name

string
other3Value

Other 3 Value

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Create a new filing calendar now!

Input

Reset

Path Parameters

Post Body

item 1

Add Item
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/filingcalendars
Method
POST
Request
[
  {}
]
Response
 

Retrieve all filing calendars

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/filingcalendars

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
companyId

Company Id

integer
returnName
Required

Return Name

string
locationCode

If this calendar is for a location-specific tax return, specify the location code here. To file for all locations, leave this value NULL.

string
outletTypeId

If this calendar is for a location-specific tax return, specify the location-specific behavior here.

string
paymentCurrency

Specify the ISO 4217 currency code for the currency to remit for this tax return. For all tax returns in the United States, specify "USD".

string
filingFrequencyId

Filing Frequency Id

string
months

Months

integer
stateRegistrationId
Required

Tax Registration ID for this Region - in the U.S., this is for your state.

string
localRegistrationId

Tax Registration ID for the local jurisdiction, if any.

string
employerIdentificationNumber

Employer Identification Number

string
line1

Line1

string
line2

Line2

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
phone

Phone

string
customerFilingInstructions

Customer Filing Instructions

string
legalEntityName

Legal Entity Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
filingTypeId

Filing Type Id

string
eFileUsername

If you file electronically, this is the username you use to log in to the tax authority's website.

string
eFilePassword

If you file electronically, this is the password or pass code you use to log in to the tax authority's website.

string
prepayPercentage

Prepay Percentage

string
taxTypeId
Required

Tax Type Id

string
internalNotes

Internal Notes

string
alSignOn

Al Sign On

string
alAccessCode

Al Access Code

string
meBusinessCode

Me Business Code

string
iaBen

Ia Ben

string
ctReg

Ct Reg

string
other1Name

Other 1 Name

string
other1Value

Other 1 Value

string
other2Name

Other 2 Name

string
other2Value

Other 2 Value

string
other3Name

Other 3 Name

string
other3Value

Other 3 Value

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve all filing calendars now!

Input

Reset

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/filingcalendars
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/filingcalendars" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve a single item

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/items/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this item object

integer
id
Required

The primary key of this item

integer

Response

id

Id

integer
itemCode
Required

Item Code

string
companyId

Company Id

integer
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
description
Required

Description

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Retrieve a single item now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/items/{id}
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/items/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Update a single item

Api Endpoint
PUT https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/items/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that this item belongs to.

integer
id
Required

The ID of the item you wish to update

integer

Post Body Parameters

id

Id

integer
itemCode
Required

Item Code

string
companyId

Company Id

integer
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
description
Required

Description

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response

id

Id

integer
itemCode
Required

Item Code

string
companyId

Company Id

integer
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
description
Required

Description

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Update a single item now!

Input

Reset

Path Parameters

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/items/{id}
Method
PUT
Request
{}
Response
 

Delete a single item

Api Endpoint
DELETE https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/items/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this item.

integer
id
Required

The ID of the item you wish to delete.

integer

Response

Error
code

Category of the error

string
message

Short one-line message to summaryize what went wrong

string
target

What object or service caused the error?

string
Array[Details]
errorCode

Error message identifier

integer
summary

Concise summary of the message

string
details

Message details

string
faultCode

Indicates the SoapFault code

string
helpLink

URL to help for this message

string
name

Name of the message.

string
refersTo

Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.

string
severity

Severity of the message

string
source

Source of the message

string
documentation

Documentation of the message

string
Try Delete a single item now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/items/{id}
Method
DELETE
Request
curl -X DELETE "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/items/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve items for this company

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/items

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Path Parameters

companyId
Required

The ID of the company that owns these items

integer

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
itemCode
Required

Item Code

string
companyId

Company Id

integer
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
description
Required

Description

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve items for this company now!

Input

Reset

Path Parameters

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/items
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/items" -H "Accept: application/json" -H "Authorization: "
Response
 

Create a new item

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/items

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this item.

integer

Post Body Parameters[Array]

id

Id

integer
itemCode
Required

Item Code

string
companyId

Company Id

integer
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
description
Required

Description

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response[Array]

id

Id

integer
itemCode
Required

Item Code

string
companyId

Company Id

integer
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
description
Required

Description

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Create a new item now!

Input

Reset

Path Parameters

Post Body

item 1

Add Item
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/items
Method
POST
Request
[
  {}
]
Response
 

Retrieve all items

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/items

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
itemCode
Required

Item Code

string
companyId

Company Id

integer
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
description
Required

Description

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve all items now!

Input

Reset

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/items
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/items" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve a single location

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/locations/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this location

integer
id
Required

The primary key of this location

integer

Response

id

Id

integer
companyId

Company Id

integer
locationCode
Required

Location Code

string
description

Description

string
addressTypeId

Address Type Id

string
addressCategoryId

Address Category Id

string
line1
Required

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
stateAssignedCode

State Assigned Code

string
isDefault

Is Default

boolean
county

County

string
isRegistered

Is Registered

boolean
dbaName

Dba Name

string
outletName

Outlet Name

string
effectiveDate

Start Date

string
endDate

End Date

string
lastTransactionDate

Last Transaction Date

string
registeredDate

Registered Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Retrieve a single location now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/locations/{id}
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/locations/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Update a single location

Api Endpoint
PUT https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/locations/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that this location belongs to.

integer
id
Required

The ID of the location you wish to update

integer

Post Body Parameters

id

Id

integer
companyId

Company Id

integer
locationCode
Required

Location Code

string
description

Description

string
addressTypeId

Address Type Id

string
addressCategoryId

Address Category Id

string
line1
Required

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
stateAssignedCode

State Assigned Code

string
isDefault

Is Default

boolean
county

County

string
isRegistered

Is Registered

boolean
dbaName

Dba Name

string
outletName

Outlet Name

string
effectiveDate

Start Date

string
endDate

End Date

string
lastTransactionDate

Last Transaction Date

string
registeredDate

Registered Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response

id

Id

integer
companyId

Company Id

integer
locationCode
Required

Location Code

string
description

Description

string
addressTypeId

Address Type Id

string
addressCategoryId

Address Category Id

string
line1
Required

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
stateAssignedCode

State Assigned Code

string
isDefault

Is Default

boolean
county

County

string
isRegistered

Is Registered

boolean
dbaName

Dba Name

string
outletName

Outlet Name

string
effectiveDate

Start Date

string
endDate

End Date

string
lastTransactionDate

Last Transaction Date

string
registeredDate

Registered Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Update a single location now!

Input

Reset

Path Parameters

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/locations/{id}
Method
PUT
Request
{}
Response
 

Delete a single location

Api Endpoint
DELETE https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/locations/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this location.

integer
id
Required

The ID of the location you wish to delete.

integer

Response

Error
code

Category of the error

string
message

Short one-line message to summaryize what went wrong

string
target

What object or service caused the error?

string
Array[Details]
errorCode

Error message identifier

integer
summary

Concise summary of the message

string
details

Message details

string
faultCode

Indicates the SoapFault code

string
helpLink

URL to help for this message

string
name

Name of the message.

string
refersTo

Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.

string
severity

Severity of the message

string
source

Source of the message

string
documentation

Documentation of the message

string
Try Delete a single location now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/locations/{id}
Method
DELETE
Request
curl -X DELETE "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/locations/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve locations for this company

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/locations

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Path Parameters

companyId
Required

The ID of the company that owns these locations

integer

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
companyId

Company Id

integer
locationCode
Required

Location Code

string
description

Description

string
addressTypeId

Address Type Id

string
addressCategoryId

Address Category Id

string
line1
Required

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
stateAssignedCode

State Assigned Code

string
isDefault

Is Default

boolean
county

County

string
isRegistered

Is Registered

boolean
dbaName

Dba Name

string
outletName

Outlet Name

string
effectiveDate

Start Date

string
endDate

End Date

string
lastTransactionDate

Last Transaction Date

string
registeredDate

Registered Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve locations for this company now!

Input

Reset

Path Parameters

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/locations
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/locations" -H "Accept: application/json" -H "Authorization: "
Response
 

Create a new location

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/locations

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this location.

integer

Post Body Parameters[Array]

id

Id

integer
companyId

Company Id

integer
locationCode
Required

Location Code

string
description

Description

string
addressTypeId

Address Type Id

string
addressCategoryId

Address Category Id

string
line1
Required

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
stateAssignedCode

State Assigned Code

string
isDefault

Is Default

boolean
county

County

string
isRegistered

Is Registered

boolean
dbaName

Dba Name

string
outletName

Outlet Name

string
effectiveDate

Start Date

string
endDate

End Date

string
lastTransactionDate

Last Transaction Date

string
registeredDate

Registered Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response[Array]

id

Id

integer
companyId

Company Id

integer
locationCode
Required

Location Code

string
description

Description

string
addressTypeId

Address Type Id

string
addressCategoryId

Address Category Id

string
line1
Required

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
stateAssignedCode

State Assigned Code

string
isDefault

Is Default

boolean
county

County

string
isRegistered

Is Registered

boolean
dbaName

Dba Name

string
outletName

Outlet Name

string
effectiveDate

Start Date

string
endDate

End Date

string
lastTransactionDate

Last Transaction Date

string
registeredDate

Registered Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Create a new location now!

Input

Reset

Path Parameters

Post Body

item 1

Add Item
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/locations
Method
POST
Request
[
  {}
]
Response
 

Retrieve all locations

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/locations

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
companyId

Company Id

integer
locationCode
Required

Location Code

string
description

Description

string
addressTypeId

Address Type Id

string
addressCategoryId

Address Category Id

string
line1
Required

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

Region

string
postalCode

Postal Code

string
country

Country

string
stateAssignedCode

State Assigned Code

string
isDefault

Is Default

boolean
county

County

string
isRegistered

Is Registered

boolean
dbaName

Dba Name

string
outletName

Outlet Name

string
effectiveDate

Start Date

string
endDate

End Date

string
lastTransactionDate

Last Transaction Date

string
registeredDate

Registered Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve all locations now!

Input

Reset

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/locations
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/locations" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve a single nexus

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/nexus/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this nexus object

integer
id
Required

The primary key of this nexus

integer

Response

id

id

integer
companyId

companyId

integer
state
Required

state

string
jurisTypeId

jurisTypeId

string
jurisCode
Required

jurisCode

string
jurisName
Required

jurisName

string
effectiveDate

effectiveDate

string
endDate

endDate

string
shortName

shortName

string
signatureCode

signatureCode

string
stateAssignedNo

stateAssignedNo

string
nexusTypeId

nexusTypeId

string
country

country

string
sourcing

sourcing

string
accountingMethodId

accountingMethodId

string
hasLocalNexus

hasLocalNexus

boolean
localNexusTypeId

localNexusTypeId

string
hasPermanentEstablishment

hasPermanentEstablishment

boolean
taxId

taxId

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Retrieve a single nexus now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/nexus/{id}
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/nexus/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Update a single nexus

Api Endpoint
PUT https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/nexus/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that this nexus belongs to.

integer
id
Required

The ID of the nexus you wish to update

integer

Post Body Parameters

id

id

integer
companyId

companyId

integer
state
Required

state

string
jurisTypeId

jurisTypeId

string
jurisCode
Required

jurisCode

string
jurisName
Required

jurisName

string
effectiveDate

effectiveDate

string
endDate

endDate

string
shortName

shortName

string
signatureCode

signatureCode

string
stateAssignedNo

stateAssignedNo

string
nexusTypeId

nexusTypeId

string
country

country

string
sourcing

sourcing

string
accountingMethodId

accountingMethodId

string
hasLocalNexus

hasLocalNexus

boolean
localNexusTypeId

localNexusTypeId

string
hasPermanentEstablishment

hasPermanentEstablishment

boolean
taxId

taxId

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response

id

id

integer
companyId

companyId

integer
state
Required

state

string
jurisTypeId

jurisTypeId

string
jurisCode
Required

jurisCode

string
jurisName
Required

jurisName

string
effectiveDate

effectiveDate

string
endDate

endDate

string
shortName

shortName

string
signatureCode

signatureCode

string
stateAssignedNo

stateAssignedNo

string
nexusTypeId

nexusTypeId

string
country

country

string
sourcing

sourcing

string
accountingMethodId

accountingMethodId

string
hasLocalNexus

hasLocalNexus

boolean
localNexusTypeId

localNexusTypeId

string
hasPermanentEstablishment

hasPermanentEstablishment

boolean
taxId

taxId

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Update a single nexus now!

Input

Reset

Path Parameters

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/nexus/{id}
Method
PUT
Request
{}
Response
 

Delete a single nexus

Api Endpoint
DELETE https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/nexus/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this nexus.

integer
id
Required

The ID of the nexus you wish to delete.

integer

Response

Error
code

Category of the error

string
message

Short one-line message to summaryize what went wrong

string
target

What object or service caused the error?

string
Array[Details]
errorCode

Error message identifier

integer
summary

Concise summary of the message

string
details

Message details

string
faultCode

Indicates the SoapFault code

string
helpLink

URL to help for this message

string
name

Name of the message.

string
refersTo

Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.

string
severity

Severity of the message

string
source

Source of the message

string
documentation

Documentation of the message

string
Try Delete a single nexus now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/nexus/{id}
Method
DELETE
Request
curl -X DELETE "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/nexus/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve nexus for this company

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/nexus

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Path Parameters

companyId
Required

The ID of the company that owns these nexus objects

integer

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

id

integer
companyId

companyId

integer
state
Required

state

string
jurisTypeId

jurisTypeId

string
jurisCode
Required

jurisCode

string
jurisName
Required

jurisName

string
effectiveDate

effectiveDate

string
endDate

endDate

string
shortName

shortName

string
signatureCode

signatureCode

string
stateAssignedNo

stateAssignedNo

string
nexusTypeId

nexusTypeId

string
country

country

string
sourcing

sourcing

string
accountingMethodId

accountingMethodId

string
hasLocalNexus

hasLocalNexus

boolean
localNexusTypeId

localNexusTypeId

string
hasPermanentEstablishment

hasPermanentEstablishment

boolean
taxId

taxId

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve nexus for this company now!

Input

Reset

Path Parameters

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/nexus
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/nexus" -H "Accept: application/json" -H "Authorization: "
Response
 

Create a new nexus

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/nexus

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this nexus.

integer

Post Body Parameters[Array]

id

id

integer
companyId

companyId

integer
state
Required

state

string
jurisTypeId

jurisTypeId

string
jurisCode
Required

jurisCode

string
jurisName
Required

jurisName

string
effectiveDate

effectiveDate

string
endDate

endDate

string
shortName

shortName

string
signatureCode

signatureCode

string
stateAssignedNo

stateAssignedNo

string
nexusTypeId

nexusTypeId

string
country

country

string
sourcing

sourcing

string
accountingMethodId

accountingMethodId

string
hasLocalNexus

hasLocalNexus

boolean
localNexusTypeId

localNexusTypeId

string
hasPermanentEstablishment

hasPermanentEstablishment

boolean
taxId

taxId

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response[Array]

id

id

integer
companyId

companyId

integer
state
Required

state

string
jurisTypeId

jurisTypeId

string
jurisCode
Required

jurisCode

string
jurisName
Required

jurisName

string
effectiveDate

effectiveDate

string
endDate

endDate

string
shortName

shortName

string
signatureCode

signatureCode

string
stateAssignedNo

stateAssignedNo

string
nexusTypeId

nexusTypeId

string
country

country

string
sourcing

sourcing

string
accountingMethodId

accountingMethodId

string
hasLocalNexus

hasLocalNexus

boolean
localNexusTypeId

localNexusTypeId

string
hasPermanentEstablishment

hasPermanentEstablishment

boolean
taxId

taxId

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Create a new nexus now!

Input

Reset

Path Parameters

Post Body

item 1

Add Item
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/nexus
Method
POST
Request
[
  {}
]
Response
 

Retrieve all nexus

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/nexus

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

id

integer
companyId

companyId

integer
state
Required

state

string
jurisTypeId

jurisTypeId

string
jurisCode
Required

jurisCode

string
jurisName
Required

jurisName

string
effectiveDate

effectiveDate

string
endDate

endDate

string
shortName

shortName

string
signatureCode

signatureCode

string
stateAssignedNo

stateAssignedNo

string
nexusTypeId

nexusTypeId

string
country

country

string
sourcing

sourcing

string
accountingMethodId

accountingMethodId

string
hasLocalNexus

hasLocalNexus

boolean
localNexusTypeId

localNexusTypeId

string
hasPermanentEstablishment

hasPermanentEstablishment

boolean
taxId

taxId

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve all nexus now!

Input

Reset

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/nexus
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/nexus" -H "Accept: application/json" -H "Authorization: "
Response
 

Change Password

Api Endpoint
PUT https://rest-sbx-preview.avalara.net/api/v2/passwords

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Post Body Parameters

oldPassword
Required

Old Password

string
newPassword
Required

New Password

string
Try Change Password now!

Input

Reset

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/passwords
Method
PUT
Request
{}
Response
 

Retrieve a single setting

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/settings/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this setting

integer
id
Required

The primary key of this setting

integer

Response

id

Id

integer
companyId

Company Id

integer
set
Required

Set

string
name
Required

Name

string
value

Value

string
Try Retrieve a single setting now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/settings/{id}
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/settings/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Update a single setting

Api Endpoint
PUT https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/settings/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that this setting belongs to.

integer
id
Required

The ID of the setting you wish to update

integer

Post Body Parameters

id

Id

integer
companyId

Company Id

integer
set
Required

Set

string
name
Required

Name

string
value

Value

string

Response

id

Id

integer
companyId

Company Id

integer
set
Required

Set

string
name
Required

Name

string
value

Value

string
Try Update a single setting now!

Input

Reset

Path Parameters

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/settings/{id}
Method
PUT
Request
{}
Response
 

Delete a single setting

Api Endpoint
DELETE https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/settings/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this setting.

integer
id
Required

The ID of the setting you wish to delete.

integer

Response

Error
code

Category of the error

string
message

Short one-line message to summaryize what went wrong

string
target

What object or service caused the error?

string
Array[Details]
errorCode

Error message identifier

integer
summary

Concise summary of the message

string
details

Message details

string
faultCode

Indicates the SoapFault code

string
helpLink

URL to help for this message

string
name

Name of the message.

string
refersTo

Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.

string
severity

Severity of the message

string
source

Source of the message

string
documentation

Documentation of the message

string
Try Delete a single setting now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/settings/{id}
Method
DELETE
Request
curl -X DELETE "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/settings/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve all settings for this company

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/settings

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Path Parameters

companyId
Required

The ID of the company that owns these settings

integer

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
companyId

Company Id

integer
set
Required

Set

string
name
Required

Name

string
value

Value

string
@nextLink

The link to the next page of results

string
Try Retrieve all settings for this company now!

Input

Reset

Path Parameters

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/settings
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/settings" -H "Accept: application/json" -H "Authorization: "
Response
 

Create a new setting

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/settings

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this setting.

integer

Post Body Parameters[Array]

id

Id

integer
companyId

Company Id

integer
set
Required

Set

string
name
Required

Name

string
value

Value

string

Response[Array]

id

Id

integer
companyId

Company Id

integer
set
Required

Set

string
name
Required

Name

string
value

Value

string
Try Create a new setting now!

Input

Reset

Path Parameters

Post Body

item 1

Add Item
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/settings
Method
POST
Request
[
  {}
]
Response
 

Retrieve all settings

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/settings

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
companyId

Company Id

integer
set
Required

Set

string
name
Required

Name

string
value

Value

string
@nextLink

The link to the next page of results

string
Try Retrieve all settings now!

Input

Reset

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/settings
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/settings" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve a single subscription

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/subscriptions/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

accountId
Required

The ID of the account that owns this subscription

integer
id
Required

The primary key of this subscription

integer

Response

id

Id

integer
accountId

Account Id

integer
subscriptionTypeId

Subscription Type Id

integer
subscriptionDescription

Subscription Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Retrieve a single subscription now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/subscriptions/{id}
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/subscriptions/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Update a single subscription

Api Endpoint
PUT https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/subscriptions/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

accountId
Required

The ID of the account that this subscription belongs to.

integer
id
Required

The ID of the subscription you wish to update

integer

Post Body Parameters

id

Id

integer
accountId

Account Id

integer
subscriptionTypeId

Subscription Type Id

integer
subscriptionDescription

Subscription Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response

id

Id

integer
accountId

Account Id

integer
subscriptionTypeId

Subscription Type Id

integer
subscriptionDescription

Subscription Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Update a single subscription now!

Input

Reset

Path Parameters

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/subscriptions/{id}
Method
PUT
Request
{}
Response
 

Delete a single subscription

Api Endpoint
DELETE https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/subscriptions/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

accountId
Required

The ID of the account that owns this subscription.

integer
id
Required

The ID of the subscription you wish to delete.

integer

Response

Error
code

Category of the error

string
message

Short one-line message to summaryize what went wrong

string
target

What object or service caused the error?

string
Array[Details]
errorCode

Error message identifier

integer
summary

Concise summary of the message

string
details

Message details

string
faultCode

Indicates the SoapFault code

string
helpLink

URL to help for this message

string
name

Name of the message.

string
refersTo

Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.

string
severity

Severity of the message

string
source

Source of the message

string
documentation

Documentation of the message

string
Try Delete a single subscription now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/subscriptions/{id}
Method
DELETE
Request
curl -X DELETE "https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/subscriptions/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve subscriptions for this account

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/subscriptions

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Path Parameters

accountId
Required

The ID of the account that owns these subscriptions

integer

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
accountId

Account Id

integer
subscriptionTypeId

Subscription Type Id

integer
subscriptionDescription

Subscription Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve subscriptions for this account now!

Input

Reset

Path Parameters

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/subscriptions
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/subscriptions" -H "Accept: application/json" -H "Authorization: "
Response
 

Create a new subscription

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/subscriptions

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

accountId
Required

The ID of the account that owns this subscription.

integer

Post Body Parameters[Array]

id

Id

integer
accountId

Account Id

integer
subscriptionTypeId

Subscription Type Id

integer
subscriptionDescription

Subscription Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response[Array]

id

Id

integer
accountId

Account Id

integer
subscriptionTypeId

Subscription Type Id

integer
subscriptionDescription

Subscription Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Create a new subscription now!

Input

Reset

Path Parameters

Post Body

item 1

Add Item
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/subscriptions
Method
POST
Request
[
  {}
]
Response
 

Retrieve all subscriptions

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/subscriptions

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
accountId

Account Id

integer
subscriptionTypeId

Subscription Type Id

integer
subscriptionDescription

Subscription Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve all subscriptions now!

Input

Reset

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/subscriptions
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/subscriptions" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve a single tax code

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxcodes/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this tax code

integer
id
Required

The primary key of this tax code

integer

Response

id

Id

integer
taxCode
Required

Tax Code

string
taxCodeTypeId
Required

Tax Code Type Id

string
companyId

Company Id

integer
description

Description

string
parentTaxCode

Parent Tax Code

string
isPhysical

Is Physical

boolean
goodsServiceCode

Good Service Code

integer
entityUseCode

Entity Use Code

string
isActive

Is Active

boolean
isSSTCertified

Is SST Certified

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Retrieve a single tax code now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxcodes/{id}
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxcodes/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Update a single tax code

Api Endpoint
PUT https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxcodes/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that this tax code belongs to.

integer
id
Required

The ID of the tax code you wish to update

integer

Post Body Parameters

id

Id

integer
taxCode
Required

Tax Code

string
taxCodeTypeId
Required

Tax Code Type Id

string
companyId

Company Id

integer
description

Description

string
parentTaxCode

Parent Tax Code

string
isPhysical

Is Physical

boolean
goodsServiceCode

Good Service Code

integer
entityUseCode

Entity Use Code

string
isActive

Is Active

boolean
isSSTCertified

Is SST Certified

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response

id

Id

integer
taxCode
Required

Tax Code

string
taxCodeTypeId
Required

Tax Code Type Id

string
companyId

Company Id

integer
description

Description

string
parentTaxCode

Parent Tax Code

string
isPhysical

Is Physical

boolean
goodsServiceCode

Good Service Code

integer
entityUseCode

Entity Use Code

string
isActive

Is Active

boolean
isSSTCertified

Is SST Certified

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Update a single tax code now!

Input

Reset

Path Parameters

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxcodes/{id}
Method
PUT
Request
{}
Response
 

Delete a single tax code

Api Endpoint
DELETE https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxcodes/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this tax code.

integer
id
Required

The ID of the tax code you wish to delete.

integer

Response

Error
code

Category of the error

string
message

Short one-line message to summaryize what went wrong

string
target

What object or service caused the error?

string
Array[Details]
errorCode

Error message identifier

integer
summary

Concise summary of the message

string
details

Message details

string
faultCode

Indicates the SoapFault code

string
helpLink

URL to help for this message

string
name

Name of the message.

string
refersTo

Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.

string
severity

Severity of the message

string
source

Source of the message

string
documentation

Documentation of the message

string
Try Delete a single tax code now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxcodes/{id}
Method
DELETE
Request
curl -X DELETE "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxcodes/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve tax codes for this company

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxcodes

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Path Parameters

companyId
Required

The ID of the company that owns these tax codes

integer

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
taxCode
Required

Tax Code

string
taxCodeTypeId
Required

Tax Code Type Id

string
companyId

Company Id

integer
description

Description

string
parentTaxCode

Parent Tax Code

string
isPhysical

Is Physical

boolean
goodsServiceCode

Good Service Code

integer
entityUseCode

Entity Use Code

string
isActive

Is Active

boolean
isSSTCertified

Is SST Certified

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve tax codes for this company now!

Input

Reset

Path Parameters

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxcodes
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxcodes" -H "Accept: application/json" -H "Authorization: "
Response
 

Create a new tax code

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxcodes

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this tax code.

integer

Post Body Parameters[Array]

id

Id

integer
taxCode
Required

Tax Code

string
taxCodeTypeId
Required

Tax Code Type Id

string
companyId

Company Id

integer
description

Description

string
parentTaxCode

Parent Tax Code

string
isPhysical

Is Physical

boolean
goodsServiceCode

Good Service Code

integer
entityUseCode

Entity Use Code

string
isActive

Is Active

boolean
isSSTCertified

Is SST Certified

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response[Array]

id

Id

integer
taxCode
Required

Tax Code

string
taxCodeTypeId
Required

Tax Code Type Id

string
companyId

Company Id

integer
description

Description

string
parentTaxCode

Parent Tax Code

string
isPhysical

Is Physical

boolean
goodsServiceCode

Good Service Code

integer
entityUseCode

Entity Use Code

string
isActive

Is Active

boolean
isSSTCertified

Is SST Certified

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Create a new tax code now!

Input

Reset

Path Parameters

Post Body

item 1

Add Item
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxcodes
Method
POST
Request
[
  {}
]
Response
 

Retrieve all tax codes

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/taxcodes

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
taxCode
Required

Tax Code

string
taxCodeTypeId
Required

Tax Code Type Id

string
companyId

Company Id

integer
description

Description

string
parentTaxCode

Parent Tax Code

string
isPhysical

Is Physical

boolean
goodsServiceCode

Good Service Code

integer
entityUseCode

Entity Use Code

string
isActive

Is Active

boolean
isSSTCertified

Is SST Certified

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve all tax codes now!

Input

Reset

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/taxcodes
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/taxcodes" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve tax rates for a specified address

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/taxrates/byaddress

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

line1

The street address of the location.

string
line2

The street address of the location.

string
line3

The street address of the location.

string
city

The city name of the location.

string
region

The state or region of the location

string
postalCode

The postal code of the location.

string
country

The two letter ISO-3166 country code.

string

Response

totalRate

Total Rate

number
Array[Rates]
rate

Rate

number
name

Name

string
type

Type

string
Try Retrieve tax rates for a specified address now!

Input

Reset

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/taxrates/byaddress
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/taxrates/byaddress" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve tax rates for a specified country and postal code

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/taxrates/bypostalcode

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

country

The two letter ISO-3166 country code.

string
postalCode

The postal code of the location.

string

Response

totalRate

Total Rate

number
Array[Rates]
rate

Rate

number
name

Name

string
type

Type

string
Try Retrieve tax rates for a specified country and postal code now!

Input

Reset

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/taxrates/bypostalcode
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/taxrates/bypostalcode" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve a single tax rule

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxrules/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this tax rule

integer
id
Required

The primary key of this tax rule

integer

Response

id

Id

integer
companyId

CompanyId

integer
stateFIPS

State FIPS

string
jurisName

Jurisdiction Name

string
jurisCode
Required

Jurisdiction Code

string
jurisTypeId

Jurisdiction Type Id

string
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
customerUsageType

Customer Usage Type

string
taxTypeId

Tax Type Id

string
rateTypeId

Rate Type Id

string
taxRuleTypeId

Tax Rule Type Id

string
isAllJuris

Is All Juris

boolean
value

Value

number
cap

Cap

number
threshold

Threshold

number
options

Options

string
effectiveDate

Effective Date

string
endDate

End Date

string
description

Description

string
countyFIPS

County FIPS

string
isSTPro

Is STPro

boolean
country
Required

Country

string
region
Required

Region

string
sourcing

Sourcing

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Retrieve a single tax rule now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxrules/{id}
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxrules/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Update a single tax rule

Api Endpoint
PUT https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxrules/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that this tax rule belongs to.

integer
id
Required

The ID of the tax rule you wish to update

integer

Post Body Parameters

id

Id

integer
companyId

CompanyId

integer
stateFIPS

State FIPS

string
jurisName

Jurisdiction Name

string
jurisCode
Required

Jurisdiction Code

string
jurisTypeId

Jurisdiction Type Id

string
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
customerUsageType

Customer Usage Type

string
taxTypeId

Tax Type Id

string
rateTypeId

Rate Type Id

string
taxRuleTypeId

Tax Rule Type Id

string
isAllJuris

Is All Juris

boolean
value

Value

number
cap

Cap

number
threshold

Threshold

number
options

Options

string
effectiveDate

Effective Date

string
endDate

End Date

string
description

Description

string
countyFIPS

County FIPS

string
isSTPro

Is STPro

boolean
country
Required

Country

string
region
Required

Region

string
sourcing

Sourcing

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response

id

Id

integer
companyId

CompanyId

integer
stateFIPS

State FIPS

string
jurisName

Jurisdiction Name

string
jurisCode
Required

Jurisdiction Code

string
jurisTypeId

Jurisdiction Type Id

string
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
customerUsageType

Customer Usage Type

string
taxTypeId

Tax Type Id

string
rateTypeId

Rate Type Id

string
taxRuleTypeId

Tax Rule Type Id

string
isAllJuris

Is All Juris

boolean
value

Value

number
cap

Cap

number
threshold

Threshold

number
options

Options

string
effectiveDate

Effective Date

string
endDate

End Date

string
description

Description

string
countyFIPS

County FIPS

string
isSTPro

Is STPro

boolean
country
Required

Country

string
region
Required

Region

string
sourcing

Sourcing

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Update a single tax rule now!

Input

Reset

Path Parameters

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxrules/{id}
Method
PUT
Request
{}
Response
 

Delete a single tax rule

Api Endpoint
DELETE https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxrules/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this tax rule.

integer
id
Required

The ID of the tax rule you wish to delete.

integer

Response

Error
code

Category of the error

string
message

Short one-line message to summaryize what went wrong

string
target

What object or service caused the error?

string
Array[Details]
errorCode

Error message identifier

integer
summary

Concise summary of the message

string
details

Message details

string
faultCode

Indicates the SoapFault code

string
helpLink

URL to help for this message

string
name

Name of the message.

string
refersTo

Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.

string
severity

Severity of the message

string
source

Source of the message

string
documentation

Documentation of the message

string
Try Delete a single tax rule now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxrules/{id}
Method
DELETE
Request
curl -X DELETE "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxrules/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve tax rules for this company

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxrules

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Path Parameters

companyId
Required

The ID of the company that owns these tax rules

integer

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
companyId

CompanyId

integer
stateFIPS

State FIPS

string
jurisName

Jurisdiction Name

string
jurisCode
Required

Jurisdiction Code

string
jurisTypeId

Jurisdiction Type Id

string
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
customerUsageType

Customer Usage Type

string
taxTypeId

Tax Type Id

string
rateTypeId

Rate Type Id

string
taxRuleTypeId

Tax Rule Type Id

string
isAllJuris

Is All Juris

boolean
value

Value

number
cap

Cap

number
threshold

Threshold

number
options

Options

string
effectiveDate

Effective Date

string
endDate

End Date

string
description

Description

string
countyFIPS

County FIPS

string
isSTPro

Is STPro

boolean
country
Required

Country

string
region
Required

Region

string
sourcing

Sourcing

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve tax rules for this company now!

Input

Reset

Path Parameters

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxrules
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxrules" -H "Accept: application/json" -H "Authorization: "
Response
 

Create a new tax rule

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxrules

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this tax rule.

integer

Post Body Parameters[Array]

id

Id

integer
companyId

CompanyId

integer
stateFIPS

State FIPS

string
jurisName

Jurisdiction Name

string
jurisCode
Required

Jurisdiction Code

string
jurisTypeId

Jurisdiction Type Id

string
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
customerUsageType

Customer Usage Type

string
taxTypeId

Tax Type Id

string
rateTypeId

Rate Type Id

string
taxRuleTypeId

Tax Rule Type Id

string
isAllJuris

Is All Juris

boolean
value

Value

number
cap

Cap

number
threshold

Threshold

number
options

Options

string
effectiveDate

Effective Date

string
endDate

End Date

string
description

Description

string
countyFIPS

County FIPS

string
isSTPro

Is STPro

boolean
country
Required

Country

string
region
Required

Region

string
sourcing

Sourcing

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response[Array]

id

Id

integer
companyId

CompanyId

integer
stateFIPS

State FIPS

string
jurisName

Jurisdiction Name

string
jurisCode
Required

Jurisdiction Code

string
jurisTypeId

Jurisdiction Type Id

string
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
customerUsageType

Customer Usage Type

string
taxTypeId

Tax Type Id

string
rateTypeId

Rate Type Id

string
taxRuleTypeId

Tax Rule Type Id

string
isAllJuris

Is All Juris

boolean
value

Value

number
cap

Cap

number
threshold

Threshold

number
options

Options

string
effectiveDate

Effective Date

string
endDate

End Date

string
description

Description

string
countyFIPS

County FIPS

string
isSTPro

Is STPro

boolean
country
Required

Country

string
region
Required

Region

string
sourcing

Sourcing

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Create a new tax rule now!

Input

Reset

Path Parameters

Post Body

item 1

Add Item
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/taxrules
Method
POST
Request
[
  {}
]
Response
 

Retrieve all tax rules

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/taxrules

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
companyId

CompanyId

integer
stateFIPS

State FIPS

string
jurisName

Jurisdiction Name

string
jurisCode
Required

Jurisdiction Code

string
jurisTypeId

Jurisdiction Type Id

string
taxCodeId

Tax Code Id

integer
taxCode

Tax Code

string
customerUsageType

Customer Usage Type

string
taxTypeId

Tax Type Id

string
rateTypeId

Rate Type Id

string
taxRuleTypeId

Tax Rule Type Id

string
isAllJuris

Is All Juris

boolean
value

Value

number
cap

Cap

number
threshold

Threshold

number
options

Options

string
effectiveDate

Effective Date

string
endDate

End Date

string
description

Description

string
countyFIPS

County FIPS

string
isSTPro

Is STPro

boolean
country
Required

Country

string
region
Required

Region

string
sourcing

Sourcing

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve all tax rules now!

Input

Reset

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/taxrules
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/taxrules" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve a single transaction

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions/{transactionCode}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$include

A comma separated list of child objects to return underneath the primary object.

string

Path Parameters

companyCode
Required

The company code of the company that recorded this transaction

string
transactionCode
Required

The transaction code to retrieve

string

Response

id

DocumentId

integer
code

DocumentCode

string
date

DocumentDate

string
taxDate

TaxDate

string
paymentDate

PaymentDate

string
status

DocumentStatusId

string
type

DocumentTypeId

string
companyId

CompanyId

integer
batchCode

BatchCode

string
currencyCode

CurrencyCode

string
customerUsageType

CustomerUsageType

string
customerVendorCode

CustomerVendorCode

string
exemptNo

ExemptNo

string
reconciled

IsReconciled

boolean
locationCode

LocationCode

string
purchaseOrderNo

PurchaseOrderNo

string
referenceCode

ReferenceCode

string
salespersonCode

SalespersonCode

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
totalAmount

TotalAmount

number
totalExempt

TotalExempt

number
totalTax

TotalTax

number
totalTaxable

TotalTaxable

number
totalTaxCalculated

TotalTaxCalculated

number
adjustmentReason

AdjustmentReasonId

string
adjustmentDescription

AdjustmentDescription

string
locked

IsLocked

boolean
region

Region

string
country

Country

string
version

Version

integer
softwareVersion

SoftwareVersion

string
originAddressId

OriginAddressId

integer
destinationAddressId

DestinationAddressId

integer
exchangeRateEffectiveDate

ExchangeRateEffDate

string
exchangeRate

ExchangeRate

number
isSellerImporterOfRecord

IsSellerImporterOfRecord

boolean
description

Description

string
email

Email

string
brBuyerType

BRBuyerType

string
brBuyer_IsExemptOrCannotWH_IRRF

BRBuyer_IsExemptOrCannotWH_IRRF

boolean
brBuyer_IsExemptOrCannotWH_PISRF

BRBuyer_IsExemptOrCannotWH_PISRF

boolean
brBuyer_IsExemptOrCannotWH_COFINSRF

BRBuyer_IsExemptOrCannotWH_COFINSRF

boolean
brBuyer_IsExemptOrCannotWH_CSLLRF

BRBuyer_IsExemptOrCannotWH_CSLLRF

boolean
brBuyer_IsExempt_PIS

BRBuyer_IsExempt_PIS

boolean
brBuyer_IsExempt_COFINS

BRBuyer_IsExempt_COFINS

boolean
brBuyer_IsExempt_CSLL

BRBuyer_IsExempt_CSLL

boolean
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Lines]
id

DocumentLineId

integer
transactionId

DocumentId

integer
lineNumber

LineNo

string
method

AccountingMethodId

string
boundaryOverrideId

BoundaryOverrideId

integer
customerUsageType

CustomerUsageType

string
description

Description

string
destinationAddressId

DestinationAddressId

integer
discountAmount

DiscountAmount

number
discountTypeId

DiscountTypeId

integer
exemptAmount

ExemptAmount

number
exemptCertId

ExemptCertId

integer
exemptNo

ExemptNo

string
isItemTaxable

IsItemTaxable

boolean
isSSTP

IsSSTP

boolean
itemCode

ItemCode

string
lineAmount

LineAmount

number
originAddressId

OriginAddressId

integer
quantity

Quantity

number
ref1

Ref1

string
ref2

Ref2

string
reportingDate

ReportingDate

string
revAccount

RevAccount

string
sourcing

Sourcing

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxCalculated

TaxCalculated

number
taxCode

TaxCode

string
taxCodeId

TaxCodeId

integer
taxDate

TaxDate

string
taxEngine

TaxEngine

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
taxIncluded

TaxIncluded

boolean
Array[Details]
id

DocumentLineDetailId

integer
transactionLineId

DocumentLineId

integer
transactionId

DocumentId

integer
addressId

AddressId

integer
country

Country

string
region

Region

string
countyFIPS

CountyFips

string
stateFIPS

StateFips

string
exemptAmount

ExemptAmount

number
exemptReasonId

ExemptReasonId

integer
inState

InState

boolean
jurisCode

JurisCode

string
jurisName

JurisName

string
jurisdictionId

JurisdictionId

integer
jurisType

JurisTypeId

string
nonTaxableAmount

NonTaxableAmount

number
nonTaxableRuleId

NonTaxableRuleId

integer
nonTaxableType

NonTaxableTypeId

string
rate

Rate

number
rateRuleId

RateRuleId

integer
rateSourceId

RateSourceId

integer
signatureCode

SignatureCode

string
serCode

SERCode

string
sourcing

Sourcing

string
stateAssignedNo

StateAssignedNo

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxType

TaxTypeId

string
taxName

TaxName

string
taxAuthorityTypeId

TaxAuthorityTypeId

integer
taxRegionId

TaxRegionId

integer
taxCalculated

TaxCalculated

number
taxOverride

TaxOverride

number
rateType

RateTypeId

string
Array[Addresses]
id

DocumentAddressId

integer
transactionId

DocumentId

integer
boundaryLevel

BoundaryLevel

string
line1

AddressLine1

string
line2

AddressLine2

string
line3

AddressLine3

string
city

City

string
region

Region

string
postalCode

PostalCode

string
country

Country

string
taxRegionId

TaxRegionId

integer
Try Retrieve a single transaction now!

Input

Reset

Path Parameters

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions/{transactionCode}
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions/{transactionCode}" -H "Accept: application/json" -H "Authorization: "
Response
 

Delete a single transaction

Api Endpoint
DELETE https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions/{transactionCode}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyCode
Required

The company code of the company that recorded this transaction

string
transactionCode
Required

The transaction code to post

string

Response[Array]

errorCode

Error message identifier

integer
summary

Concise summary of the message

string
details

Message details

string
faultCode

Indicates the SoapFault code

string
helpLink

URL to help for this message

string
name

Name of the message.

string
refersTo

Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.

string
severity

Severity of the message

string
source

Source of the message

string
documentation

Documentation of the message

string
Try Delete a single transaction now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions/{transactionCode}
Method
DELETE
Request
curl -X DELETE "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions/{transactionCode}" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve all transactions

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$include

A comma separated list of child objects to return underneath the primary object.

string
$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Path Parameters

companyCode
Required

The company code of the company that recorded this transaction

string

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

DocumentId

integer
code

DocumentCode

string
date

DocumentDate

string
taxDate

TaxDate

string
paymentDate

PaymentDate

string
status

DocumentStatusId

string
type

DocumentTypeId

string
companyId

CompanyId

integer
batchCode

BatchCode

string
currencyCode

CurrencyCode

string
customerUsageType

CustomerUsageType

string
customerVendorCode

CustomerVendorCode

string
exemptNo

ExemptNo

string
reconciled

IsReconciled

boolean
locationCode

LocationCode

string
purchaseOrderNo

PurchaseOrderNo

string
referenceCode

ReferenceCode

string
salespersonCode

SalespersonCode

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
totalAmount

TotalAmount

number
totalExempt

TotalExempt

number
totalTax

TotalTax

number
totalTaxable

TotalTaxable

number
totalTaxCalculated

TotalTaxCalculated

number
adjustmentReason

AdjustmentReasonId

string
adjustmentDescription

AdjustmentDescription

string
locked

IsLocked

boolean
region

Region

string
country

Country

string
version

Version

integer
softwareVersion

SoftwareVersion

string
originAddressId

OriginAddressId

integer
destinationAddressId

DestinationAddressId

integer
exchangeRateEffectiveDate

ExchangeRateEffDate

string
exchangeRate

ExchangeRate

number
isSellerImporterOfRecord

IsSellerImporterOfRecord

boolean
description

Description

string
email

Email

string
brBuyerType

BRBuyerType

string
brBuyer_IsExemptOrCannotWH_IRRF

BRBuyer_IsExemptOrCannotWH_IRRF

boolean
brBuyer_IsExemptOrCannotWH_PISRF

BRBuyer_IsExemptOrCannotWH_PISRF

boolean
brBuyer_IsExemptOrCannotWH_COFINSRF

BRBuyer_IsExemptOrCannotWH_COFINSRF

boolean
brBuyer_IsExemptOrCannotWH_CSLLRF

BRBuyer_IsExemptOrCannotWH_CSLLRF

boolean
brBuyer_IsExempt_PIS

BRBuyer_IsExempt_PIS

boolean
brBuyer_IsExempt_COFINS

BRBuyer_IsExempt_COFINS

boolean
brBuyer_IsExempt_CSLL

BRBuyer_IsExempt_CSLL

boolean
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Lines]
id

DocumentLineId

integer
transactionId

DocumentId

integer
lineNumber

LineNo

string
method

AccountingMethodId

string
boundaryOverrideId

BoundaryOverrideId

integer
customerUsageType

CustomerUsageType

string
description

Description

string
destinationAddressId

DestinationAddressId

integer
discountAmount

DiscountAmount

number
discountTypeId

DiscountTypeId

integer
exemptAmount

ExemptAmount

number
exemptCertId

ExemptCertId

integer
exemptNo

ExemptNo

string
isItemTaxable

IsItemTaxable

boolean
isSSTP

IsSSTP

boolean
itemCode

ItemCode

string
lineAmount

LineAmount

number
originAddressId

OriginAddressId

integer
quantity

Quantity

number
ref1

Ref1

string
ref2

Ref2

string
reportingDate

ReportingDate

string
revAccount

RevAccount

string
sourcing

Sourcing

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxCalculated

TaxCalculated

number
taxCode

TaxCode

string
taxCodeId

TaxCodeId

integer
taxDate

TaxDate

string
taxEngine

TaxEngine

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
taxIncluded

TaxIncluded

boolean
Array[Details]
id

DocumentLineDetailId

integer
transactionLineId

DocumentLineId

integer
transactionId

DocumentId

integer
addressId

AddressId

integer
country

Country

string
region

Region

string
countyFIPS

CountyFips

string
stateFIPS

StateFips

string
exemptAmount

ExemptAmount

number
exemptReasonId

ExemptReasonId

integer
inState

InState

boolean
jurisCode

JurisCode

string
jurisName

JurisName

string
jurisdictionId

JurisdictionId

integer
jurisType

JurisTypeId

string
nonTaxableAmount

NonTaxableAmount

number
nonTaxableRuleId

NonTaxableRuleId

integer
nonTaxableType

NonTaxableTypeId

string
rate

Rate

number
rateRuleId

RateRuleId

integer
rateSourceId

RateSourceId

integer
signatureCode

SignatureCode

string
serCode

SERCode

string
sourcing

Sourcing

string
stateAssignedNo

StateAssignedNo

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxType

TaxTypeId

string
taxName

TaxName

string
taxAuthorityTypeId

TaxAuthorityTypeId

integer
taxRegionId

TaxRegionId

integer
taxCalculated

TaxCalculated

number
taxOverride

TaxOverride

number
rateType

RateTypeId

string
Array[Addresses]
id

DocumentAddressId

integer
transactionId

DocumentId

integer
boundaryLevel

BoundaryLevel

string
line1

AddressLine1

string
line2

AddressLine2

string
line3

AddressLine3

string
city

City

string
region

Region

string
postalCode

PostalCode

string
country

Country

string
taxRegionId

TaxRegionId

integer
@nextLink

The link to the next page of results

string
Try Retrieve all transactions now!

Input

Reset

Path Parameters

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions" -H "Accept: application/json" -H "Authorization: "
Response
 

Correct a previously created transaction

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions/{transactionCode}/adjust

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyCode
Required

The company code of the company that recorded this transaction

string
transactionCode
Required

The transaction code to adjust

string

Post Body Parameters

adjustmentReason

A reason code indicating why this adjustment was made

string
adjustmentDescription

If the AdjustmentReason is "Other", specify the reason here

string
NewTransaction
companyCode
Required

Company Code - The client application company reference code.

string
type

Document Type

string
code
Required

Transaction Code - the internal reference code used by the client application. This is used for operations such as Post and GetTaxHistory.

string
date
Required

Transaction Date - The date on the invoice, purchase order, etc.

string
salespersonCode

Salesperson Code - The client application salesperson reference code.

string
customerCode

Customer Code - The client application customer reference code.

string
customerUsageType

Customer Usage Type - The client application customer or usage type.

string
discount

Discount - The discount amount to apply to the document.

number
purchaseOrderNo

Purchase Order Number for this document

string
exemptionNo

Exemption Number for this document

string
Addresses
Unknown
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
ShipFrom
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
ShipTo
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
PointOfOrderAcceptance
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
PointOfOrderOrigin
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
SingleLocation
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
Other
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
Array[Lines]
number

Line number within this document

string
quantity
Required

Quantity of items in this line

number
amount
Required

Total amount for this line

number
Addresses
Unknown
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
ShipFrom
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
ShipTo
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
PointOfOrderAcceptance
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
PointOfOrderOrigin
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
SingleLocation
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
Other
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
taxCode

Tax Code - System or Custom Tax Code.

string
customerUsageType

Customer Usage Type - The client application customer or usage type.

string
itemCode

Item Code (SKU)

string
exemptionCode

Exemption number for this line

string
discounted

True if the document discount should be applied to this line

boolean
taxIncluded

Indicates if line has Tax Included; defaults to false

boolean
revenueAccount

Revenue Account

string
ref1

Reference 1 - Client specific reference field

string
ref2

Reference 2 - Client specific reference field

string
description

Item description. This is required for SST transactions if an unmapped ItemCode is used.

string
businessIdentificationNo

BusinessIdentificationNo

string
TaxOverride
type

Identifies the type of tax override

string
taxAmount

Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines.

number
taxDate

The override tax date to use

string
reason

This provides the reason for a tax override for audit purposes. It is required for types 2-4.

string
referenceCode

Reference Code used to reference the original document for a return invoice

string
hashCode

The hash code is computed by the client to determine whether any changes have occured since taxes were calculated.

integer
reportingLocationCode

Sets the sale location code (Outlet ID) for reporting this document to the tax authority.

string
commit

Causes the document to be committed if true.

boolean
batchCode

BatchCode for batch operations.

string
TaxOverride
type

Identifies the type of tax override

string
taxAmount

Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines.

number
taxDate

The override tax date to use

string
reason

This provides the reason for a tax override for audit purposes. It is required for types 2-4.

string
taxDate

Indicates the tax effectivity override date for the entire document.

string
currencyCode

3 character ISO 4217 currency code.

string
serviceMode

Specifies whether the tax calculation is handled Local, Remote, or Automatic (default)

string
paymentDate

Indicates the date payment was applied to this document. This is only for cash basis accounting.

string
exchangeRate

Currency exchange rate from this transaction to the company base currency.

number
exchangeRateEffectiveDate

Effective date of the exchange rate.

string
posLaneCode

Sets the POS Lane Code sent by the User for this document.

string
businessIdentificationNo

BusinessIdentificationNo

string
isSellerImporterOfRecord

Specifies if the Transaction has the seller as IsSellerImporterOfRecord

boolean
description

Description

string
email

Email

string

Response

id

DocumentId

integer
code

DocumentCode

string
date

DocumentDate

string
taxDate

TaxDate

string
paymentDate

PaymentDate

string
status

DocumentStatusId

string
type

DocumentTypeId

string
companyId

CompanyId

integer
batchCode

BatchCode

string
currencyCode

CurrencyCode

string
customerUsageType

CustomerUsageType

string
customerVendorCode

CustomerVendorCode

string
exemptNo

ExemptNo

string
reconciled

IsReconciled

boolean
locationCode

LocationCode

string
purchaseOrderNo

PurchaseOrderNo

string
referenceCode

ReferenceCode

string
salespersonCode

SalespersonCode

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
totalAmount

TotalAmount

number
totalExempt

TotalExempt

number
totalTax

TotalTax

number
totalTaxable

TotalTaxable

number
totalTaxCalculated

TotalTaxCalculated

number
adjustmentReason

AdjustmentReasonId

string
adjustmentDescription

AdjustmentDescription

string
locked

IsLocked

boolean
region

Region

string
country

Country

string
version

Version

integer
softwareVersion

SoftwareVersion

string
originAddressId

OriginAddressId

integer
destinationAddressId

DestinationAddressId

integer
exchangeRateEffectiveDate

ExchangeRateEffDate

string
exchangeRate

ExchangeRate

number
isSellerImporterOfRecord

IsSellerImporterOfRecord

boolean
description

Description

string
email

Email

string
brBuyerType

BRBuyerType

string
brBuyer_IsExemptOrCannotWH_IRRF

BRBuyer_IsExemptOrCannotWH_IRRF

boolean
brBuyer_IsExemptOrCannotWH_PISRF

BRBuyer_IsExemptOrCannotWH_PISRF

boolean
brBuyer_IsExemptOrCannotWH_COFINSRF

BRBuyer_IsExemptOrCannotWH_COFINSRF

boolean
brBuyer_IsExemptOrCannotWH_CSLLRF

BRBuyer_IsExemptOrCannotWH_CSLLRF

boolean
brBuyer_IsExempt_PIS

BRBuyer_IsExempt_PIS

boolean
brBuyer_IsExempt_COFINS

BRBuyer_IsExempt_COFINS

boolean
brBuyer_IsExempt_CSLL

BRBuyer_IsExempt_CSLL

boolean
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Lines]
id

DocumentLineId

integer
transactionId

DocumentId

integer
lineNumber

LineNo

string
method

AccountingMethodId

string
boundaryOverrideId

BoundaryOverrideId

integer
customerUsageType

CustomerUsageType

string
description

Description

string
destinationAddressId

DestinationAddressId

integer
discountAmount

DiscountAmount

number
discountTypeId

DiscountTypeId

integer
exemptAmount

ExemptAmount

number
exemptCertId

ExemptCertId

integer
exemptNo

ExemptNo

string
isItemTaxable

IsItemTaxable

boolean
isSSTP

IsSSTP

boolean
itemCode

ItemCode

string
lineAmount

LineAmount

number
originAddressId

OriginAddressId

integer
quantity

Quantity

number
ref1

Ref1

string
ref2

Ref2

string
reportingDate

ReportingDate

string
revAccount

RevAccount

string
sourcing

Sourcing

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxCalculated

TaxCalculated

number
taxCode

TaxCode

string
taxCodeId

TaxCodeId

integer
taxDate

TaxDate

string
taxEngine

TaxEngine

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
taxIncluded

TaxIncluded

boolean
Array[Details]
id

DocumentLineDetailId

integer
transactionLineId

DocumentLineId

integer
transactionId

DocumentId

integer
addressId

AddressId

integer
country

Country

string
region

Region

string
countyFIPS

CountyFips

string
stateFIPS

StateFips

string
exemptAmount

ExemptAmount

number
exemptReasonId

ExemptReasonId

integer
inState

InState

boolean
jurisCode

JurisCode

string
jurisName

JurisName

string
jurisdictionId

JurisdictionId

integer
jurisType

JurisTypeId

string
nonTaxableAmount

NonTaxableAmount

number
nonTaxableRuleId

NonTaxableRuleId

integer
nonTaxableType

NonTaxableTypeId

string
rate

Rate

number
rateRuleId

RateRuleId

integer
rateSourceId

RateSourceId

integer
signatureCode

SignatureCode

string
serCode

SERCode

string
sourcing

Sourcing

string
stateAssignedNo

StateAssignedNo

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxType

TaxTypeId

string
taxName

TaxName

string
taxAuthorityTypeId

TaxAuthorityTypeId

integer
taxRegionId

TaxRegionId

integer
taxCalculated

TaxCalculated

number
taxOverride

TaxOverride

number
rateType

RateTypeId

string
Array[Addresses]
id

DocumentAddressId

integer
transactionId

DocumentId

integer
boundaryLevel

BoundaryLevel

string
line1

AddressLine1

string
line2

AddressLine2

string
line3

AddressLine3

string
city

City

string
region

Region

string
postalCode

PostalCode

string
country

Country

string
taxRegionId

TaxRegionId

integer
Try Correct a previously created transaction now!

Input

Reset

Path Parameters

Post Body

newTransaction

addresses

Unknown

ShipFrom

ShipTo

PointOfOrderAcceptance

PointOfOrderOrigin

SingleLocation

Other

lines

item 1

addresses

Unknown

ShipFrom

ShipTo

PointOfOrderAcceptance

PointOfOrderOrigin

SingleLocation

Other

taxOverride

Add lines

taxOverride

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions/{transactionCode}/adjust
Method
POST
Request
{
  "newTransaction": {
    "addresses": {
      "Unknown": {},
      "ShipFrom": {},
      "ShipTo": {},
      "PointOfOrderAcceptance": {},
      "PointOfOrderOrigin": {},
      "SingleLocation": {},
      "Other": {}
    },
    "lines": [
      {
        "addresses": {
          "Unknown": {},
          "ShipFrom": {},
          "ShipTo": {},
          "PointOfOrderAcceptance": {},
          "PointOfOrderOrigin": {},
          "SingleLocation": {},
          "Other": {}
        },
        "taxOverride": {}
      }
    ],
    "taxOverride": {}
  }
}
Response
 

Convert an invoice into a sale or purchase

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions/{transactionCode}/commit

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyCode
Required

The company code of the company that recorded this transaction

string
transactionCode
Required

The transaction code to commit

string

Post Body Parameters

newTransactionCode

If you wish to change the transaction code when committing the transaction, specify the new transaction code here.

string

Response

id

DocumentId

integer
code

DocumentCode

string
date

DocumentDate

string
taxDate

TaxDate

string
paymentDate

PaymentDate

string
status

DocumentStatusId

string
type

DocumentTypeId

string
companyId

CompanyId

integer
batchCode

BatchCode

string
currencyCode

CurrencyCode

string
customerUsageType

CustomerUsageType

string
customerVendorCode

CustomerVendorCode

string
exemptNo

ExemptNo

string
reconciled

IsReconciled

boolean
locationCode

LocationCode

string
purchaseOrderNo

PurchaseOrderNo

string
referenceCode

ReferenceCode

string
salespersonCode

SalespersonCode

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
totalAmount

TotalAmount

number
totalExempt

TotalExempt

number
totalTax

TotalTax

number
totalTaxable

TotalTaxable

number
totalTaxCalculated

TotalTaxCalculated

number
adjustmentReason

AdjustmentReasonId

string
adjustmentDescription

AdjustmentDescription

string
locked

IsLocked

boolean
region

Region

string
country

Country

string
version

Version

integer
softwareVersion

SoftwareVersion

string
originAddressId

OriginAddressId

integer
destinationAddressId

DestinationAddressId

integer
exchangeRateEffectiveDate

ExchangeRateEffDate

string
exchangeRate

ExchangeRate

number
isSellerImporterOfRecord

IsSellerImporterOfRecord

boolean
description

Description

string
email

Email

string
brBuyerType

BRBuyerType

string
brBuyer_IsExemptOrCannotWH_IRRF

BRBuyer_IsExemptOrCannotWH_IRRF

boolean
brBuyer_IsExemptOrCannotWH_PISRF

BRBuyer_IsExemptOrCannotWH_PISRF

boolean
brBuyer_IsExemptOrCannotWH_COFINSRF

BRBuyer_IsExemptOrCannotWH_COFINSRF

boolean
brBuyer_IsExemptOrCannotWH_CSLLRF

BRBuyer_IsExemptOrCannotWH_CSLLRF

boolean
brBuyer_IsExempt_PIS

BRBuyer_IsExempt_PIS

boolean
brBuyer_IsExempt_COFINS

BRBuyer_IsExempt_COFINS

boolean
brBuyer_IsExempt_CSLL

BRBuyer_IsExempt_CSLL

boolean
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Lines]
id

DocumentLineId

integer
transactionId

DocumentId

integer
lineNumber

LineNo

string
method

AccountingMethodId

string
boundaryOverrideId

BoundaryOverrideId

integer
customerUsageType

CustomerUsageType

string
description

Description

string
destinationAddressId

DestinationAddressId

integer
discountAmount

DiscountAmount

number
discountTypeId

DiscountTypeId

integer
exemptAmount

ExemptAmount

number
exemptCertId

ExemptCertId

integer
exemptNo

ExemptNo

string
isItemTaxable

IsItemTaxable

boolean
isSSTP

IsSSTP

boolean
itemCode

ItemCode

string
lineAmount

LineAmount

number
originAddressId

OriginAddressId

integer
quantity

Quantity

number
ref1

Ref1

string
ref2

Ref2

string
reportingDate

ReportingDate

string
revAccount

RevAccount

string
sourcing

Sourcing

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxCalculated

TaxCalculated

number
taxCode

TaxCode

string
taxCodeId

TaxCodeId

integer
taxDate

TaxDate

string
taxEngine

TaxEngine

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
taxIncluded

TaxIncluded

boolean
Array[Details]
id

DocumentLineDetailId

integer
transactionLineId

DocumentLineId

integer
transactionId

DocumentId

integer
addressId

AddressId

integer
country

Country

string
region

Region

string
countyFIPS

CountyFips

string
stateFIPS

StateFips

string
exemptAmount

ExemptAmount

number
exemptReasonId

ExemptReasonId

integer
inState

InState

boolean
jurisCode

JurisCode

string
jurisName

JurisName

string
jurisdictionId

JurisdictionId

integer
jurisType

JurisTypeId

string
nonTaxableAmount

NonTaxableAmount

number
nonTaxableRuleId

NonTaxableRuleId

integer
nonTaxableType

NonTaxableTypeId

string
rate

Rate

number
rateRuleId

RateRuleId

integer
rateSourceId

RateSourceId

integer
signatureCode

SignatureCode

string
serCode

SERCode

string
sourcing

Sourcing

string
stateAssignedNo

StateAssignedNo

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxType

TaxTypeId

string
taxName

TaxName

string
taxAuthorityTypeId

TaxAuthorityTypeId

integer
taxRegionId

TaxRegionId

integer
taxCalculated

TaxCalculated

number
taxOverride

TaxOverride

number
rateType

RateTypeId

string
Array[Addresses]
id

DocumentAddressId

integer
transactionId

DocumentId

integer
boundaryLevel

BoundaryLevel

string
line1

AddressLine1

string
line2

AddressLine2

string
line3

AddressLine3

string
city

City

string
region

Region

string
postalCode

PostalCode

string
country

Country

string
taxRegionId

TaxRegionId

integer
Try Convert an invoice into a sale or purchase now!

Input

Reset

Path Parameters

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions/{transactionCode}/commit
Method
POST
Request
{}
Response
 

Cancel a transaction

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions/{transactionCode}/cancel

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyCode
Required

The company code of the company that recorded this transaction

string
transactionCode
Required

The transaction code to cancel

string

Post Body Parameters

code

Please specify the reason for cancelling this transaction

string

Response

id

DocumentId

integer
code

DocumentCode

string
date

DocumentDate

string
taxDate

TaxDate

string
paymentDate

PaymentDate

string
status

DocumentStatusId

string
type

DocumentTypeId

string
companyId

CompanyId

integer
batchCode

BatchCode

string
currencyCode

CurrencyCode

string
customerUsageType

CustomerUsageType

string
customerVendorCode

CustomerVendorCode

string
exemptNo

ExemptNo

string
reconciled

IsReconciled

boolean
locationCode

LocationCode

string
purchaseOrderNo

PurchaseOrderNo

string
referenceCode

ReferenceCode

string
salespersonCode

SalespersonCode

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
totalAmount

TotalAmount

number
totalExempt

TotalExempt

number
totalTax

TotalTax

number
totalTaxable

TotalTaxable

number
totalTaxCalculated

TotalTaxCalculated

number
adjustmentReason

AdjustmentReasonId

string
adjustmentDescription

AdjustmentDescription

string
locked

IsLocked

boolean
region

Region

string
country

Country

string
version

Version

integer
softwareVersion

SoftwareVersion

string
originAddressId

OriginAddressId

integer
destinationAddressId

DestinationAddressId

integer
exchangeRateEffectiveDate

ExchangeRateEffDate

string
exchangeRate

ExchangeRate

number
isSellerImporterOfRecord

IsSellerImporterOfRecord

boolean
description

Description

string
email

Email

string
brBuyerType

BRBuyerType

string
brBuyer_IsExemptOrCannotWH_IRRF

BRBuyer_IsExemptOrCannotWH_IRRF

boolean
brBuyer_IsExemptOrCannotWH_PISRF

BRBuyer_IsExemptOrCannotWH_PISRF

boolean
brBuyer_IsExemptOrCannotWH_COFINSRF

BRBuyer_IsExemptOrCannotWH_COFINSRF

boolean
brBuyer_IsExemptOrCannotWH_CSLLRF

BRBuyer_IsExemptOrCannotWH_CSLLRF

boolean
brBuyer_IsExempt_PIS

BRBuyer_IsExempt_PIS

boolean
brBuyer_IsExempt_COFINS

BRBuyer_IsExempt_COFINS

boolean
brBuyer_IsExempt_CSLL

BRBuyer_IsExempt_CSLL

boolean
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Lines]
id

DocumentLineId

integer
transactionId

DocumentId

integer
lineNumber

LineNo

string
method

AccountingMethodId

string
boundaryOverrideId

BoundaryOverrideId

integer
customerUsageType

CustomerUsageType

string
description

Description

string
destinationAddressId

DestinationAddressId

integer
discountAmount

DiscountAmount

number
discountTypeId

DiscountTypeId

integer
exemptAmount

ExemptAmount

number
exemptCertId

ExemptCertId

integer
exemptNo

ExemptNo

string
isItemTaxable

IsItemTaxable

boolean
isSSTP

IsSSTP

boolean
itemCode

ItemCode

string
lineAmount

LineAmount

number
originAddressId

OriginAddressId

integer
quantity

Quantity

number
ref1

Ref1

string
ref2

Ref2

string
reportingDate

ReportingDate

string
revAccount

RevAccount

string
sourcing

Sourcing

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxCalculated

TaxCalculated

number
taxCode

TaxCode

string
taxCodeId

TaxCodeId

integer
taxDate

TaxDate

string
taxEngine

TaxEngine

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
taxIncluded

TaxIncluded

boolean
Array[Details]
id

DocumentLineDetailId

integer
transactionLineId

DocumentLineId

integer
transactionId

DocumentId

integer
addressId

AddressId

integer
country

Country

string
region

Region

string
countyFIPS

CountyFips

string
stateFIPS

StateFips

string
exemptAmount

ExemptAmount

number
exemptReasonId

ExemptReasonId

integer
inState

InState

boolean
jurisCode

JurisCode

string
jurisName

JurisName

string
jurisdictionId

JurisdictionId

integer
jurisType

JurisTypeId

string
nonTaxableAmount

NonTaxableAmount

number
nonTaxableRuleId

NonTaxableRuleId

integer
nonTaxableType

NonTaxableTypeId

string
rate

Rate

number
rateRuleId

RateRuleId

integer
rateSourceId

RateSourceId

integer
signatureCode

SignatureCode

string
serCode

SERCode

string
sourcing

Sourcing

string
stateAssignedNo

StateAssignedNo

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxType

TaxTypeId

string
taxName

TaxName

string
taxAuthorityTypeId

TaxAuthorityTypeId

integer
taxRegionId

TaxRegionId

integer
taxCalculated

TaxCalculated

number
taxOverride

TaxOverride

number
rateType

RateTypeId

string
Array[Addresses]
id

DocumentAddressId

integer
transactionId

DocumentId

integer
boundaryLevel

BoundaryLevel

string
line1

AddressLine1

string
line2

AddressLine2

string
line3

AddressLine3

string
city

City

string
region

Region

string
postalCode

PostalCode

string
country

Country

string
taxRegionId

TaxRegionId

integer
Try Cancel a transaction now!

Input

Reset

Path Parameters

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions/{transactionCode}/cancel
Method
POST
Request
{}
Response
 

Mark a transaction as posted to the ledger

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions/{transactionCode}/post

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyCode
Required

The company code of the company that recorded this transaction

string
transactionCode
Required

The transaction code to post

string

Post Body Parameters

verifyTransactionDate

Transaction Date - The date on the invoice, purchase order, etc.

string
verifyTotalAmount

Total Amount - The total amount (not including tax) for the document.

number
verifyTotalTax

Total Tax - The total tax for the document.

number
verifyHashCode

The hash code for the document.

integer
commitTransaction

Allows committing immediately rather than requiring a subsequent call to CommitTax.

boolean
newTransactionCode

If you wish to change the transaction code when committing the transaction, specify the new transaction code here.

string

Response

id

DocumentId

integer
code

DocumentCode

string
date

DocumentDate

string
taxDate

TaxDate

string
paymentDate

PaymentDate

string
status

DocumentStatusId

string
type

DocumentTypeId

string
companyId

CompanyId

integer
batchCode

BatchCode

string
currencyCode

CurrencyCode

string
customerUsageType

CustomerUsageType

string
customerVendorCode

CustomerVendorCode

string
exemptNo

ExemptNo

string
reconciled

IsReconciled

boolean
locationCode

LocationCode

string
purchaseOrderNo

PurchaseOrderNo

string
referenceCode

ReferenceCode

string
salespersonCode

SalespersonCode

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
totalAmount

TotalAmount

number
totalExempt

TotalExempt

number
totalTax

TotalTax

number
totalTaxable

TotalTaxable

number
totalTaxCalculated

TotalTaxCalculated

number
adjustmentReason

AdjustmentReasonId

string
adjustmentDescription

AdjustmentDescription

string
locked

IsLocked

boolean
region

Region

string
country

Country

string
version

Version

integer
softwareVersion

SoftwareVersion

string
originAddressId

OriginAddressId

integer
destinationAddressId

DestinationAddressId

integer
exchangeRateEffectiveDate

ExchangeRateEffDate

string
exchangeRate

ExchangeRate

number
isSellerImporterOfRecord

IsSellerImporterOfRecord

boolean
description

Description

string
email

Email

string
brBuyerType

BRBuyerType

string
brBuyer_IsExemptOrCannotWH_IRRF

BRBuyer_IsExemptOrCannotWH_IRRF

boolean
brBuyer_IsExemptOrCannotWH_PISRF

BRBuyer_IsExemptOrCannotWH_PISRF

boolean
brBuyer_IsExemptOrCannotWH_COFINSRF

BRBuyer_IsExemptOrCannotWH_COFINSRF

boolean
brBuyer_IsExemptOrCannotWH_CSLLRF

BRBuyer_IsExemptOrCannotWH_CSLLRF

boolean
brBuyer_IsExempt_PIS

BRBuyer_IsExempt_PIS

boolean
brBuyer_IsExempt_COFINS

BRBuyer_IsExempt_COFINS

boolean
brBuyer_IsExempt_CSLL

BRBuyer_IsExempt_CSLL

boolean
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Lines]
id

DocumentLineId

integer
transactionId

DocumentId

integer
lineNumber

LineNo

string
method

AccountingMethodId

string
boundaryOverrideId

BoundaryOverrideId

integer
customerUsageType

CustomerUsageType

string
description

Description

string
destinationAddressId

DestinationAddressId

integer
discountAmount

DiscountAmount

number
discountTypeId

DiscountTypeId

integer
exemptAmount

ExemptAmount

number
exemptCertId

ExemptCertId

integer
exemptNo

ExemptNo

string
isItemTaxable

IsItemTaxable

boolean
isSSTP

IsSSTP

boolean
itemCode

ItemCode

string
lineAmount

LineAmount

number
originAddressId

OriginAddressId

integer
quantity

Quantity

number
ref1

Ref1

string
ref2

Ref2

string
reportingDate

ReportingDate

string
revAccount

RevAccount

string
sourcing

Sourcing

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxCalculated

TaxCalculated

number
taxCode

TaxCode

string
taxCodeId

TaxCodeId

integer
taxDate

TaxDate

string
taxEngine

TaxEngine

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
taxIncluded

TaxIncluded

boolean
Array[Details]
id

DocumentLineDetailId

integer
transactionLineId

DocumentLineId

integer
transactionId

DocumentId

integer
addressId

AddressId

integer
country

Country

string
region

Region

string
countyFIPS

CountyFips

string
stateFIPS

StateFips

string
exemptAmount

ExemptAmount

number
exemptReasonId

ExemptReasonId

integer
inState

InState

boolean
jurisCode

JurisCode

string
jurisName

JurisName

string
jurisdictionId

JurisdictionId

integer
jurisType

JurisTypeId

string
nonTaxableAmount

NonTaxableAmount

number
nonTaxableRuleId

NonTaxableRuleId

integer
nonTaxableType

NonTaxableTypeId

string
rate

Rate

number
rateRuleId

RateRuleId

integer
rateSourceId

RateSourceId

integer
signatureCode

SignatureCode

string
serCode

SERCode

string
sourcing

Sourcing

string
stateAssignedNo

StateAssignedNo

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxType

TaxTypeId

string
taxName

TaxName

string
taxAuthorityTypeId

TaxAuthorityTypeId

integer
taxRegionId

TaxRegionId

integer
taxCalculated

TaxCalculated

number
taxOverride

TaxOverride

number
rateType

RateTypeId

string
Array[Addresses]
id

DocumentAddressId

integer
transactionId

DocumentId

integer
boundaryLevel

BoundaryLevel

string
line1

AddressLine1

string
line2

AddressLine2

string
line3

AddressLine3

string
city

City

string
region

Region

string
postalCode

PostalCode

string
country

Country

string
taxRegionId

TaxRegionId

integer
Try Mark a transaction as posted to the ledger now!

Input

Reset

Path Parameters

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions/{transactionCode}/post
Method
POST
Request
{}
Response
 

Create a new transaction

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions/create

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyCode
Required

The company code of the company that recorded these transactions

string

Post Body Parameters[Array]

companyCode
Required

Company Code - The client application company reference code.

string
type

Document Type

string
code
Required

Transaction Code - the internal reference code used by the client application. This is used for operations such as Post and GetTaxHistory.

string
date
Required

Transaction Date - The date on the invoice, purchase order, etc.

string
salespersonCode

Salesperson Code - The client application salesperson reference code.

string
customerCode

Customer Code - The client application customer reference code.

string
customerUsageType

Customer Usage Type - The client application customer or usage type.

string
discount

Discount - The discount amount to apply to the document.

number
purchaseOrderNo

Purchase Order Number for this document

string
exemptionNo

Exemption Number for this document

string
Addresses
Unknown
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
ShipFrom
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
ShipTo
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
PointOfOrderAcceptance
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
PointOfOrderOrigin
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
SingleLocation
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
Other
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
Array[Lines]
number

Line number within this document

string
quantity
Required

Quantity of items in this line

number
amount
Required

Total amount for this line

number
Addresses
Unknown
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
ShipFrom
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
ShipTo
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
PointOfOrderAcceptance
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
PointOfOrderOrigin
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
SingleLocation
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
Other
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
taxCode

Tax Code - System or Custom Tax Code.

string
customerUsageType

Customer Usage Type - The client application customer or usage type.

string
itemCode

Item Code (SKU)

string
exemptionCode

Exemption number for this line

string
discounted

True if the document discount should be applied to this line

boolean
taxIncluded

Indicates if line has Tax Included; defaults to false

boolean
revenueAccount

Revenue Account

string
ref1

Reference 1 - Client specific reference field

string
ref2

Reference 2 - Client specific reference field

string
description

Item description. This is required for SST transactions if an unmapped ItemCode is used.

string
businessIdentificationNo

BusinessIdentificationNo

string
TaxOverride
type

Identifies the type of tax override

string
taxAmount

Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines.

number
taxDate

The override tax date to use

string
reason

This provides the reason for a tax override for audit purposes. It is required for types 2-4.

string
referenceCode

Reference Code used to reference the original document for a return invoice

string
hashCode

The hash code is computed by the client to determine whether any changes have occured since taxes were calculated.

integer
reportingLocationCode

Sets the sale location code (Outlet ID) for reporting this document to the tax authority.

string
commit

Causes the document to be committed if true.

boolean
batchCode

BatchCode for batch operations.

string
TaxOverride
type

Identifies the type of tax override

string
taxAmount

Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines.

number
taxDate

The override tax date to use

string
reason

This provides the reason for a tax override for audit purposes. It is required for types 2-4.

string
taxDate

Indicates the tax effectivity override date for the entire document.

string
currencyCode

3 character ISO 4217 currency code.

string
serviceMode

Specifies whether the tax calculation is handled Local, Remote, or Automatic (default)

string
paymentDate

Indicates the date payment was applied to this document. This is only for cash basis accounting.

string
exchangeRate

Currency exchange rate from this transaction to the company base currency.

number
exchangeRateEffectiveDate

Effective date of the exchange rate.

string
posLaneCode

Sets the POS Lane Code sent by the User for this document.

string
businessIdentificationNo

BusinessIdentificationNo

string
isSellerImporterOfRecord

Specifies if the Transaction has the seller as IsSellerImporterOfRecord

boolean
description

Description

string
email

Email

string

Response[Array]

id

DocumentId

integer
code

DocumentCode

string
date

DocumentDate

string
taxDate

TaxDate

string
paymentDate

PaymentDate

string
status

DocumentStatusId

string
type

DocumentTypeId

string
companyId

CompanyId

integer
batchCode

BatchCode

string
currencyCode

CurrencyCode

string
customerUsageType

CustomerUsageType

string
customerVendorCode

CustomerVendorCode

string
exemptNo

ExemptNo

string
reconciled

IsReconciled

boolean
locationCode

LocationCode

string
purchaseOrderNo

PurchaseOrderNo

string
referenceCode

ReferenceCode

string
salespersonCode

SalespersonCode

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
totalAmount

TotalAmount

number
totalExempt

TotalExempt

number
totalTax

TotalTax

number
totalTaxable

TotalTaxable

number
totalTaxCalculated

TotalTaxCalculated

number
adjustmentReason

AdjustmentReasonId

string
adjustmentDescription

AdjustmentDescription

string
locked

IsLocked

boolean
region

Region

string
country

Country

string
version

Version

integer
softwareVersion

SoftwareVersion

string
originAddressId

OriginAddressId

integer
destinationAddressId

DestinationAddressId

integer
exchangeRateEffectiveDate

ExchangeRateEffDate

string
exchangeRate

ExchangeRate

number
isSellerImporterOfRecord

IsSellerImporterOfRecord

boolean
description

Description

string
email

Email

string
brBuyerType

BRBuyerType

string
brBuyer_IsExemptOrCannotWH_IRRF

BRBuyer_IsExemptOrCannotWH_IRRF

boolean
brBuyer_IsExemptOrCannotWH_PISRF

BRBuyer_IsExemptOrCannotWH_PISRF

boolean
brBuyer_IsExemptOrCannotWH_COFINSRF

BRBuyer_IsExemptOrCannotWH_COFINSRF

boolean
brBuyer_IsExemptOrCannotWH_CSLLRF

BRBuyer_IsExemptOrCannotWH_CSLLRF

boolean
brBuyer_IsExempt_PIS

BRBuyer_IsExempt_PIS

boolean
brBuyer_IsExempt_COFINS

BRBuyer_IsExempt_COFINS

boolean
brBuyer_IsExempt_CSLL

BRBuyer_IsExempt_CSLL

boolean
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Lines]
id

DocumentLineId

integer
transactionId

DocumentId

integer
lineNumber

LineNo

string
method

AccountingMethodId

string
boundaryOverrideId

BoundaryOverrideId

integer
customerUsageType

CustomerUsageType

string
description

Description

string
destinationAddressId

DestinationAddressId

integer
discountAmount

DiscountAmount

number
discountTypeId

DiscountTypeId

integer
exemptAmount

ExemptAmount

number
exemptCertId

ExemptCertId

integer
exemptNo

ExemptNo

string
isItemTaxable

IsItemTaxable

boolean
isSSTP

IsSSTP

boolean
itemCode

ItemCode

string
lineAmount

LineAmount

number
originAddressId

OriginAddressId

integer
quantity

Quantity

number
ref1

Ref1

string
ref2

Ref2

string
reportingDate

ReportingDate

string
revAccount

RevAccount

string
sourcing

Sourcing

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxCalculated

TaxCalculated

number
taxCode

TaxCode

string
taxCodeId

TaxCodeId

integer
taxDate

TaxDate

string
taxEngine

TaxEngine

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
taxIncluded

TaxIncluded

boolean
Array[Details]
id

DocumentLineDetailId

integer
transactionLineId

DocumentLineId

integer
transactionId

DocumentId

integer
addressId

AddressId

integer
country

Country

string
region

Region

string
countyFIPS

CountyFips

string
stateFIPS

StateFips

string
exemptAmount

ExemptAmount

number
exemptReasonId

ExemptReasonId

integer
inState

InState

boolean
jurisCode

JurisCode

string
jurisName

JurisName

string
jurisdictionId

JurisdictionId

integer
jurisType

JurisTypeId

string
nonTaxableAmount

NonTaxableAmount

number
nonTaxableRuleId

NonTaxableRuleId

integer
nonTaxableType

NonTaxableTypeId

string
rate

Rate

number
rateRuleId

RateRuleId

integer
rateSourceId

RateSourceId

integer
signatureCode

SignatureCode

string
serCode

SERCode

string
sourcing

Sourcing

string
stateAssignedNo

StateAssignedNo

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxType

TaxTypeId

string
taxName

TaxName

string
taxAuthorityTypeId

TaxAuthorityTypeId

integer
taxRegionId

TaxRegionId

integer
taxCalculated

TaxCalculated

number
taxOverride

TaxOverride

number
rateType

RateTypeId

string
Array[Addresses]
id

DocumentAddressId

integer
transactionId

DocumentId

integer
boundaryLevel

BoundaryLevel

string
line1

AddressLine1

string
line2

AddressLine2

string
line3

AddressLine3

string
city

City

string
region

Region

string
postalCode

PostalCode

string
country

Country

string
taxRegionId

TaxRegionId

integer
Try Create a new transaction now!

Input

Reset

Path Parameters

Post Body

item 1

addresses

Unknown

ShipFrom

ShipTo

PointOfOrderAcceptance

PointOfOrderOrigin

SingleLocation

Other

lines

item 1

addresses

Unknown

ShipFrom

ShipTo

PointOfOrderAcceptance

PointOfOrderOrigin

SingleLocation

Other

taxOverride

Add lines

taxOverride

Add Item
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyCode}/transactions/create
Method
POST
Request
[
  {
    "addresses": {
      "Unknown": {},
      "ShipFrom": {},
      "ShipTo": {},
      "PointOfOrderAcceptance": {},
      "PointOfOrderOrigin": {},
      "SingleLocation": {},
      "Other": {}
    },
    "lines": [
      {
        "addresses": {
          "Unknown": {},
          "ShipFrom": {},
          "ShipTo": {},
          "PointOfOrderAcceptance": {},
          "PointOfOrderOrigin": {},
          "SingleLocation": {},
          "Other": {}
        },
        "taxOverride": {}
      }
    ],
    "taxOverride": {}
  }
]
Response
 

Retrieve a single transaction

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/transactions/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$include

A comma separated list of child objects to return underneath the primary object.

string

Path Parameters

id
Required

The id of this transaction

integer

Response

id

DocumentId

integer
code

DocumentCode

string
date

DocumentDate

string
taxDate

TaxDate

string
paymentDate

PaymentDate

string
status

DocumentStatusId

string
type

DocumentTypeId

string
companyId

CompanyId

integer
batchCode

BatchCode

string
currencyCode

CurrencyCode

string
customerUsageType

CustomerUsageType

string
customerVendorCode

CustomerVendorCode

string
exemptNo

ExemptNo

string
reconciled

IsReconciled

boolean
locationCode

LocationCode

string
purchaseOrderNo

PurchaseOrderNo

string
referenceCode

ReferenceCode

string
salespersonCode

SalespersonCode

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
totalAmount

TotalAmount

number
totalExempt

TotalExempt

number
totalTax

TotalTax

number
totalTaxable

TotalTaxable

number
totalTaxCalculated

TotalTaxCalculated

number
adjustmentReason

AdjustmentReasonId

string
adjustmentDescription

AdjustmentDescription

string
locked

IsLocked

boolean
region

Region

string
country

Country

string
version

Version

integer
softwareVersion

SoftwareVersion

string
originAddressId

OriginAddressId

integer
destinationAddressId

DestinationAddressId

integer
exchangeRateEffectiveDate

ExchangeRateEffDate

string
exchangeRate

ExchangeRate

number
isSellerImporterOfRecord

IsSellerImporterOfRecord

boolean
description

Description

string
email

Email

string
brBuyerType

BRBuyerType

string
brBuyer_IsExemptOrCannotWH_IRRF

BRBuyer_IsExemptOrCannotWH_IRRF

boolean
brBuyer_IsExemptOrCannotWH_PISRF

BRBuyer_IsExemptOrCannotWH_PISRF

boolean
brBuyer_IsExemptOrCannotWH_COFINSRF

BRBuyer_IsExemptOrCannotWH_COFINSRF

boolean
brBuyer_IsExemptOrCannotWH_CSLLRF

BRBuyer_IsExemptOrCannotWH_CSLLRF

boolean
brBuyer_IsExempt_PIS

BRBuyer_IsExempt_PIS

boolean
brBuyer_IsExempt_COFINS

BRBuyer_IsExempt_COFINS

boolean
brBuyer_IsExempt_CSLL

BRBuyer_IsExempt_CSLL

boolean
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Lines]
id

DocumentLineId

integer
transactionId

DocumentId

integer
lineNumber

LineNo

string
method

AccountingMethodId

string
boundaryOverrideId

BoundaryOverrideId

integer
customerUsageType

CustomerUsageType

string
description

Description

string
destinationAddressId

DestinationAddressId

integer
discountAmount

DiscountAmount

number
discountTypeId

DiscountTypeId

integer
exemptAmount

ExemptAmount

number
exemptCertId

ExemptCertId

integer
exemptNo

ExemptNo

string
isItemTaxable

IsItemTaxable

boolean
isSSTP

IsSSTP

boolean
itemCode

ItemCode

string
lineAmount

LineAmount

number
originAddressId

OriginAddressId

integer
quantity

Quantity

number
ref1

Ref1

string
ref2

Ref2

string
reportingDate

ReportingDate

string
revAccount

RevAccount

string
sourcing

Sourcing

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxCalculated

TaxCalculated

number
taxCode

TaxCode

string
taxCodeId

TaxCodeId

integer
taxDate

TaxDate

string
taxEngine

TaxEngine

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
taxIncluded

TaxIncluded

boolean
Array[Details]
id

DocumentLineDetailId

integer
transactionLineId

DocumentLineId

integer
transactionId

DocumentId

integer
addressId

AddressId

integer
country

Country

string
region

Region

string
countyFIPS

CountyFips

string
stateFIPS

StateFips

string
exemptAmount

ExemptAmount

number
exemptReasonId

ExemptReasonId

integer
inState

InState

boolean
jurisCode

JurisCode

string
jurisName

JurisName

string
jurisdictionId

JurisdictionId

integer
jurisType

JurisTypeId

string
nonTaxableAmount

NonTaxableAmount

number
nonTaxableRuleId

NonTaxableRuleId

integer
nonTaxableType

NonTaxableTypeId

string
rate

Rate

number
rateRuleId

RateRuleId

integer
rateSourceId

RateSourceId

integer
signatureCode

SignatureCode

string
serCode

SERCode

string
sourcing

Sourcing

string
stateAssignedNo

StateAssignedNo

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxType

TaxTypeId

string
taxName

TaxName

string
taxAuthorityTypeId

TaxAuthorityTypeId

integer
taxRegionId

TaxRegionId

integer
taxCalculated

TaxCalculated

number
taxOverride

TaxOverride

number
rateType

RateTypeId

string
Array[Addresses]
id

DocumentAddressId

integer
transactionId

DocumentId

integer
boundaryLevel

BoundaryLevel

string
line1

AddressLine1

string
line2

AddressLine2

string
line3

AddressLine3

string
city

City

string
region

Region

string
postalCode

PostalCode

string
country

Country

string
taxRegionId

TaxRegionId

integer
Try Retrieve a single transaction now!

Input

Reset

Path Parameters

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/transactions/{id}
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/transactions/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Delete a single transaction

Api Endpoint
DELETE https://rest-sbx-preview.avalara.net/api/v2/transactions/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

id
Required

The ID of the transaction you wish to delete.

integer

Response[Array]

errorCode

Error message identifier

integer
summary

Concise summary of the message

string
details

Message details

string
faultCode

Indicates the SoapFault code

string
helpLink

URL to help for this message

string
name

Name of the message.

string
refersTo

Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.

string
severity

Severity of the message

string
source

Source of the message

string
documentation

Documentation of the message

string
Try Delete a single transaction now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/transactions/{id}
Method
DELETE
Request
curl -X DELETE "https://rest-sbx-preview.avalara.net/api/v2/transactions/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Correct a previously created transaction

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/transactions/{id}/adjust

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

id
Required

The ID of the transaction you wish to update

integer

Post Body Parameters

adjustmentReason

A reason code indicating why this adjustment was made

string
adjustmentDescription

If the AdjustmentReason is "Other", specify the reason here

string
NewTransaction
companyCode
Required

Company Code - The client application company reference code.

string
type

Document Type

string
code
Required

Transaction Code - the internal reference code used by the client application. This is used for operations such as Post and GetTaxHistory.

string
date
Required

Transaction Date - The date on the invoice, purchase order, etc.

string
salespersonCode

Salesperson Code - The client application salesperson reference code.

string
customerCode

Customer Code - The client application customer reference code.

string
customerUsageType

Customer Usage Type - The client application customer or usage type.

string
discount

Discount - The discount amount to apply to the document.

number
purchaseOrderNo

Purchase Order Number for this document

string
exemptionNo

Exemption Number for this document

string
Addresses
Unknown
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
ShipFrom
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
ShipTo
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
PointOfOrderAcceptance
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
PointOfOrderOrigin
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
SingleLocation
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
Other
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
Array[Lines]
number

Line number within this document

string
quantity
Required

Quantity of items in this line

number
amount
Required

Total amount for this line

number
Addresses
Unknown
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
ShipFrom
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
ShipTo
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
PointOfOrderAcceptance
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
PointOfOrderOrigin
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
SingleLocation
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
Other
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
taxCode

Tax Code - System or Custom Tax Code.

string
customerUsageType

Customer Usage Type - The client application customer or usage type.

string
itemCode

Item Code (SKU)

string
exemptionCode

Exemption number for this line

string
discounted

True if the document discount should be applied to this line

boolean
taxIncluded

Indicates if line has Tax Included; defaults to false

boolean
revenueAccount

Revenue Account

string
ref1

Reference 1 - Client specific reference field

string
ref2

Reference 2 - Client specific reference field

string
description

Item description. This is required for SST transactions if an unmapped ItemCode is used.

string
businessIdentificationNo

BusinessIdentificationNo

string
TaxOverride
type

Identifies the type of tax override

string
taxAmount

Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines.

number
taxDate

The override tax date to use

string
reason

This provides the reason for a tax override for audit purposes. It is required for types 2-4.

string
referenceCode

Reference Code used to reference the original document for a return invoice

string
hashCode

The hash code is computed by the client to determine whether any changes have occured since taxes were calculated.

integer
reportingLocationCode

Sets the sale location code (Outlet ID) for reporting this document to the tax authority.

string
commit

Causes the document to be committed if true.

boolean
batchCode

BatchCode for batch operations.

string
TaxOverride
type

Identifies the type of tax override

string
taxAmount

Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines.

number
taxDate

The override tax date to use

string
reason

This provides the reason for a tax override for audit purposes. It is required for types 2-4.

string
taxDate

Indicates the tax effectivity override date for the entire document.

string
currencyCode

3 character ISO 4217 currency code.

string
serviceMode

Specifies whether the tax calculation is handled Local, Remote, or Automatic (default)

string
paymentDate

Indicates the date payment was applied to this document. This is only for cash basis accounting.

string
exchangeRate

Currency exchange rate from this transaction to the company base currency.

number
exchangeRateEffectiveDate

Effective date of the exchange rate.

string
posLaneCode

Sets the POS Lane Code sent by the User for this document.

string
businessIdentificationNo

BusinessIdentificationNo

string
isSellerImporterOfRecord

Specifies if the Transaction has the seller as IsSellerImporterOfRecord

boolean
description

Description

string
email

Email

string

Response

id

DocumentId

integer
code

DocumentCode

string
date

DocumentDate

string
taxDate

TaxDate

string
paymentDate

PaymentDate

string
status

DocumentStatusId

string
type

DocumentTypeId

string
companyId

CompanyId

integer
batchCode

BatchCode

string
currencyCode

CurrencyCode

string
customerUsageType

CustomerUsageType

string
customerVendorCode

CustomerVendorCode

string
exemptNo

ExemptNo

string
reconciled

IsReconciled

boolean
locationCode

LocationCode

string
purchaseOrderNo

PurchaseOrderNo

string
referenceCode

ReferenceCode

string
salespersonCode

SalespersonCode

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
totalAmount

TotalAmount

number
totalExempt

TotalExempt

number
totalTax

TotalTax

number
totalTaxable

TotalTaxable

number
totalTaxCalculated

TotalTaxCalculated

number
adjustmentReason

AdjustmentReasonId

string
adjustmentDescription

AdjustmentDescription

string
locked

IsLocked

boolean
region

Region

string
country

Country

string
version

Version

integer
softwareVersion

SoftwareVersion

string
originAddressId

OriginAddressId

integer
destinationAddressId

DestinationAddressId

integer
exchangeRateEffectiveDate

ExchangeRateEffDate

string
exchangeRate

ExchangeRate

number
isSellerImporterOfRecord

IsSellerImporterOfRecord

boolean
description

Description

string
email

Email

string
brBuyerType

BRBuyerType

string
brBuyer_IsExemptOrCannotWH_IRRF

BRBuyer_IsExemptOrCannotWH_IRRF

boolean
brBuyer_IsExemptOrCannotWH_PISRF

BRBuyer_IsExemptOrCannotWH_PISRF

boolean
brBuyer_IsExemptOrCannotWH_COFINSRF

BRBuyer_IsExemptOrCannotWH_COFINSRF

boolean
brBuyer_IsExemptOrCannotWH_CSLLRF

BRBuyer_IsExemptOrCannotWH_CSLLRF

boolean
brBuyer_IsExempt_PIS

BRBuyer_IsExempt_PIS

boolean
brBuyer_IsExempt_COFINS

BRBuyer_IsExempt_COFINS

boolean
brBuyer_IsExempt_CSLL

BRBuyer_IsExempt_CSLL

boolean
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Lines]
id

DocumentLineId

integer
transactionId

DocumentId

integer
lineNumber

LineNo

string
method

AccountingMethodId

string
boundaryOverrideId

BoundaryOverrideId

integer
customerUsageType

CustomerUsageType

string
description

Description

string
destinationAddressId

DestinationAddressId

integer
discountAmount

DiscountAmount

number
discountTypeId

DiscountTypeId

integer
exemptAmount

ExemptAmount

number
exemptCertId

ExemptCertId

integer
exemptNo

ExemptNo

string
isItemTaxable

IsItemTaxable

boolean
isSSTP

IsSSTP

boolean
itemCode

ItemCode

string
lineAmount

LineAmount

number
originAddressId

OriginAddressId

integer
quantity

Quantity

number
ref1

Ref1

string
ref2

Ref2

string
reportingDate

ReportingDate

string
revAccount

RevAccount

string
sourcing

Sourcing

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxCalculated

TaxCalculated

number
taxCode

TaxCode

string
taxCodeId

TaxCodeId

integer
taxDate

TaxDate

string
taxEngine

TaxEngine

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
taxIncluded

TaxIncluded

boolean
Array[Details]
id

DocumentLineDetailId

integer
transactionLineId

DocumentLineId

integer
transactionId

DocumentId

integer
addressId

AddressId

integer
country

Country

string
region

Region

string
countyFIPS

CountyFips

string
stateFIPS

StateFips

string
exemptAmount

ExemptAmount

number
exemptReasonId

ExemptReasonId

integer
inState

InState

boolean
jurisCode

JurisCode

string
jurisName

JurisName

string
jurisdictionId

JurisdictionId

integer
jurisType

JurisTypeId

string
nonTaxableAmount

NonTaxableAmount

number
nonTaxableRuleId

NonTaxableRuleId

integer
nonTaxableType

NonTaxableTypeId

string
rate

Rate

number
rateRuleId

RateRuleId

integer
rateSourceId

RateSourceId

integer
signatureCode

SignatureCode

string
serCode

SERCode

string
sourcing

Sourcing

string
stateAssignedNo

StateAssignedNo

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxType

TaxTypeId

string
taxName

TaxName

string
taxAuthorityTypeId

TaxAuthorityTypeId

integer
taxRegionId

TaxRegionId

integer
taxCalculated

TaxCalculated

number
taxOverride

TaxOverride

number
rateType

RateTypeId

string
Array[Addresses]
id

DocumentAddressId

integer
transactionId

DocumentId

integer
boundaryLevel

BoundaryLevel

string
line1

AddressLine1

string
line2

AddressLine2

string
line3

AddressLine3

string
city

City

string
region

Region

string
postalCode

PostalCode

string
country

Country

string
taxRegionId

TaxRegionId

integer
Try Correct a previously created transaction now!

Input

Reset

Path Parameters

Post Body

newTransaction

addresses

Unknown

ShipFrom

ShipTo

PointOfOrderAcceptance

PointOfOrderOrigin

SingleLocation

Other

lines

item 1

addresses

Unknown

ShipFrom

ShipTo

PointOfOrderAcceptance

PointOfOrderOrigin

SingleLocation

Other

taxOverride

Add lines

taxOverride

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/transactions/{id}/adjust
Method
POST
Request
{
  "newTransaction": {
    "addresses": {
      "Unknown": {},
      "ShipFrom": {},
      "ShipTo": {},
      "PointOfOrderAcceptance": {},
      "PointOfOrderOrigin": {},
      "SingleLocation": {},
      "Other": {}
    },
    "lines": [
      {
        "addresses": {
          "Unknown": {},
          "ShipFrom": {},
          "ShipTo": {},
          "PointOfOrderAcceptance": {},
          "PointOfOrderOrigin": {},
          "SingleLocation": {},
          "Other": {}
        },
        "taxOverride": {}
      }
    ],
    "taxOverride": {}
  }
}
Response
 

Convert an invoice into a sale or purchase

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/transactions/{id}/commit

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

id
Required

The ID of the transaction you wish to update

integer

Post Body Parameters

newTransactionCode

If you wish to change the transaction code when committing the transaction, specify the new transaction code here.

string

Response

id

DocumentId

integer
code

DocumentCode

string
date

DocumentDate

string
taxDate

TaxDate

string
paymentDate

PaymentDate

string
status

DocumentStatusId

string
type

DocumentTypeId

string
companyId

CompanyId

integer
batchCode

BatchCode

string
currencyCode

CurrencyCode

string
customerUsageType

CustomerUsageType

string
customerVendorCode

CustomerVendorCode

string
exemptNo

ExemptNo

string
reconciled

IsReconciled

boolean
locationCode

LocationCode

string
purchaseOrderNo

PurchaseOrderNo

string
referenceCode

ReferenceCode

string
salespersonCode

SalespersonCode

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
totalAmount

TotalAmount

number
totalExempt

TotalExempt

number
totalTax

TotalTax

number
totalTaxable

TotalTaxable

number
totalTaxCalculated

TotalTaxCalculated

number
adjustmentReason

AdjustmentReasonId

string
adjustmentDescription

AdjustmentDescription

string
locked

IsLocked

boolean
region

Region

string
country

Country

string
version

Version

integer
softwareVersion

SoftwareVersion

string
originAddressId

OriginAddressId

integer
destinationAddressId

DestinationAddressId

integer
exchangeRateEffectiveDate

ExchangeRateEffDate

string
exchangeRate

ExchangeRate

number
isSellerImporterOfRecord

IsSellerImporterOfRecord

boolean
description

Description

string
email

Email

string
brBuyerType

BRBuyerType

string
brBuyer_IsExemptOrCannotWH_IRRF

BRBuyer_IsExemptOrCannotWH_IRRF

boolean
brBuyer_IsExemptOrCannotWH_PISRF

BRBuyer_IsExemptOrCannotWH_PISRF

boolean
brBuyer_IsExemptOrCannotWH_COFINSRF

BRBuyer_IsExemptOrCannotWH_COFINSRF

boolean
brBuyer_IsExemptOrCannotWH_CSLLRF

BRBuyer_IsExemptOrCannotWH_CSLLRF

boolean
brBuyer_IsExempt_PIS

BRBuyer_IsExempt_PIS

boolean
brBuyer_IsExempt_COFINS

BRBuyer_IsExempt_COFINS

boolean
brBuyer_IsExempt_CSLL

BRBuyer_IsExempt_CSLL

boolean
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Lines]
id

DocumentLineId

integer
transactionId

DocumentId

integer
lineNumber

LineNo

string
method

AccountingMethodId

string
boundaryOverrideId

BoundaryOverrideId

integer
customerUsageType

CustomerUsageType

string
description

Description

string
destinationAddressId

DestinationAddressId

integer
discountAmount

DiscountAmount

number
discountTypeId

DiscountTypeId

integer
exemptAmount

ExemptAmount

number
exemptCertId

ExemptCertId

integer
exemptNo

ExemptNo

string
isItemTaxable

IsItemTaxable

boolean
isSSTP

IsSSTP

boolean
itemCode

ItemCode

string
lineAmount

LineAmount

number
originAddressId

OriginAddressId

integer
quantity

Quantity

number
ref1

Ref1

string
ref2

Ref2

string
reportingDate

ReportingDate

string
revAccount

RevAccount

string
sourcing

Sourcing

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxCalculated

TaxCalculated

number
taxCode

TaxCode

string
taxCodeId

TaxCodeId

integer
taxDate

TaxDate

string
taxEngine

TaxEngine

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
taxIncluded

TaxIncluded

boolean
Array[Details]
id

DocumentLineDetailId

integer
transactionLineId

DocumentLineId

integer
transactionId

DocumentId

integer
addressId

AddressId

integer
country

Country

string
region

Region

string
countyFIPS

CountyFips

string
stateFIPS

StateFips

string
exemptAmount

ExemptAmount

number
exemptReasonId

ExemptReasonId

integer
inState

InState

boolean
jurisCode

JurisCode

string
jurisName

JurisName

string
jurisdictionId

JurisdictionId

integer
jurisType

JurisTypeId

string
nonTaxableAmount

NonTaxableAmount

number
nonTaxableRuleId

NonTaxableRuleId

integer
nonTaxableType

NonTaxableTypeId

string
rate

Rate

number
rateRuleId

RateRuleId

integer
rateSourceId

RateSourceId

integer
signatureCode

SignatureCode

string
serCode

SERCode

string
sourcing

Sourcing

string
stateAssignedNo

StateAssignedNo

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxType

TaxTypeId

string
taxName

TaxName

string
taxAuthorityTypeId

TaxAuthorityTypeId

integer
taxRegionId

TaxRegionId

integer
taxCalculated

TaxCalculated

number
taxOverride

TaxOverride

number
rateType

RateTypeId

string
Array[Addresses]
id

DocumentAddressId

integer
transactionId

DocumentId

integer
boundaryLevel

BoundaryLevel

string
line1

AddressLine1

string
line2

AddressLine2

string
line3

AddressLine3

string
city

City

string
region

Region

string
postalCode

PostalCode

string
country

Country

string
taxRegionId

TaxRegionId

integer
Try Convert an invoice into a sale or purchase now!

Input

Reset

Path Parameters

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/transactions/{id}/commit
Method
POST
Request
{}
Response
 

Cancel a transaction

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/transactions/{id}/cancel

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

id
Required

The ID of the transaction you wish to update

integer

Post Body Parameters

code

Please specify the reason for cancelling this transaction

string

Response

id

DocumentId

integer
code

DocumentCode

string
date

DocumentDate

string
taxDate

TaxDate

string
paymentDate

PaymentDate

string
status

DocumentStatusId

string
type

DocumentTypeId

string
companyId

CompanyId

integer
batchCode

BatchCode

string
currencyCode

CurrencyCode

string
customerUsageType

CustomerUsageType

string
customerVendorCode

CustomerVendorCode

string
exemptNo

ExemptNo

string
reconciled

IsReconciled

boolean
locationCode

LocationCode

string
purchaseOrderNo

PurchaseOrderNo

string
referenceCode

ReferenceCode

string
salespersonCode

SalespersonCode

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
totalAmount

TotalAmount

number
totalExempt

TotalExempt

number
totalTax

TotalTax

number
totalTaxable

TotalTaxable

number
totalTaxCalculated

TotalTaxCalculated

number
adjustmentReason

AdjustmentReasonId

string
adjustmentDescription

AdjustmentDescription

string
locked

IsLocked

boolean
region

Region

string
country

Country

string
version

Version

integer
softwareVersion

SoftwareVersion

string
originAddressId

OriginAddressId

integer
destinationAddressId

DestinationAddressId

integer
exchangeRateEffectiveDate

ExchangeRateEffDate

string
exchangeRate

ExchangeRate

number
isSellerImporterOfRecord

IsSellerImporterOfRecord

boolean
description

Description

string
email

Email

string
brBuyerType

BRBuyerType

string
brBuyer_IsExemptOrCannotWH_IRRF

BRBuyer_IsExemptOrCannotWH_IRRF

boolean
brBuyer_IsExemptOrCannotWH_PISRF

BRBuyer_IsExemptOrCannotWH_PISRF

boolean
brBuyer_IsExemptOrCannotWH_COFINSRF

BRBuyer_IsExemptOrCannotWH_COFINSRF

boolean
brBuyer_IsExemptOrCannotWH_CSLLRF

BRBuyer_IsExemptOrCannotWH_CSLLRF

boolean
brBuyer_IsExempt_PIS

BRBuyer_IsExempt_PIS

boolean
brBuyer_IsExempt_COFINS

BRBuyer_IsExempt_COFINS

boolean
brBuyer_IsExempt_CSLL

BRBuyer_IsExempt_CSLL

boolean
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Lines]
id

DocumentLineId

integer
transactionId

DocumentId

integer
lineNumber

LineNo

string
method

AccountingMethodId

string
boundaryOverrideId

BoundaryOverrideId

integer
customerUsageType

CustomerUsageType

string
description

Description

string
destinationAddressId

DestinationAddressId

integer
discountAmount

DiscountAmount

number
discountTypeId

DiscountTypeId

integer
exemptAmount

ExemptAmount

number
exemptCertId

ExemptCertId

integer
exemptNo

ExemptNo

string
isItemTaxable

IsItemTaxable

boolean
isSSTP

IsSSTP

boolean
itemCode

ItemCode

string
lineAmount

LineAmount

number
originAddressId

OriginAddressId

integer
quantity

Quantity

number
ref1

Ref1

string
ref2

Ref2

string
reportingDate

ReportingDate

string
revAccount

RevAccount

string
sourcing

Sourcing

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxCalculated

TaxCalculated

number
taxCode

TaxCode

string
taxCodeId

TaxCodeId

integer
taxDate

TaxDate

string
taxEngine

TaxEngine

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
taxIncluded

TaxIncluded

boolean
Array[Details]
id

DocumentLineDetailId

integer
transactionLineId

DocumentLineId

integer
transactionId

DocumentId

integer
addressId

AddressId

integer
country

Country

string
region

Region

string
countyFIPS

CountyFips

string
stateFIPS

StateFips

string
exemptAmount

ExemptAmount

number
exemptReasonId

ExemptReasonId

integer
inState

InState

boolean
jurisCode

JurisCode

string
jurisName

JurisName

string
jurisdictionId

JurisdictionId

integer
jurisType

JurisTypeId

string
nonTaxableAmount

NonTaxableAmount

number
nonTaxableRuleId

NonTaxableRuleId

integer
nonTaxableType

NonTaxableTypeId

string
rate

Rate

number
rateRuleId

RateRuleId

integer
rateSourceId

RateSourceId

integer
signatureCode

SignatureCode

string
serCode

SERCode

string
sourcing

Sourcing

string
stateAssignedNo

StateAssignedNo

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxType

TaxTypeId

string
taxName

TaxName

string
taxAuthorityTypeId

TaxAuthorityTypeId

integer
taxRegionId

TaxRegionId

integer
taxCalculated

TaxCalculated

number
taxOverride

TaxOverride

number
rateType

RateTypeId

string
Array[Addresses]
id

DocumentAddressId

integer
transactionId

DocumentId

integer
boundaryLevel

BoundaryLevel

string
line1

AddressLine1

string
line2

AddressLine2

string
line3

AddressLine3

string
city

City

string
region

Region

string
postalCode

PostalCode

string
country

Country

string
taxRegionId

TaxRegionId

integer
Try Cancel a transaction now!

Input

Reset

Path Parameters

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/transactions/{id}/cancel
Method
POST
Request
{}
Response
 

Mark a transaction as posted to the ledger

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/transactions/{id}/post

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

id
Required

The ID of the transaction you wish to update

integer

Post Body Parameters

verifyTransactionDate

Transaction Date - The date on the invoice, purchase order, etc.

string
verifyTotalAmount

Total Amount - The total amount (not including tax) for the document.

number
verifyTotalTax

Total Tax - The total tax for the document.

number
verifyHashCode

The hash code for the document.

integer
commitTransaction

Allows committing immediately rather than requiring a subsequent call to CommitTax.

boolean
newTransactionCode

If you wish to change the transaction code when committing the transaction, specify the new transaction code here.

string

Response

id

DocumentId

integer
code

DocumentCode

string
date

DocumentDate

string
taxDate

TaxDate

string
paymentDate

PaymentDate

string
status

DocumentStatusId

string
type

DocumentTypeId

string
companyId

CompanyId

integer
batchCode

BatchCode

string
currencyCode

CurrencyCode

string
customerUsageType

CustomerUsageType

string
customerVendorCode

CustomerVendorCode

string
exemptNo

ExemptNo

string
reconciled

IsReconciled

boolean
locationCode

LocationCode

string
purchaseOrderNo

PurchaseOrderNo

string
referenceCode

ReferenceCode

string
salespersonCode

SalespersonCode

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
totalAmount

TotalAmount

number
totalExempt

TotalExempt

number
totalTax

TotalTax

number
totalTaxable

TotalTaxable

number
totalTaxCalculated

TotalTaxCalculated

number
adjustmentReason

AdjustmentReasonId

string
adjustmentDescription

AdjustmentDescription

string
locked

IsLocked

boolean
region

Region

string
country

Country

string
version

Version

integer
softwareVersion

SoftwareVersion

string
originAddressId

OriginAddressId

integer
destinationAddressId

DestinationAddressId

integer
exchangeRateEffectiveDate

ExchangeRateEffDate

string
exchangeRate

ExchangeRate

number
isSellerImporterOfRecord

IsSellerImporterOfRecord

boolean
description

Description

string
email

Email

string
brBuyerType

BRBuyerType

string
brBuyer_IsExemptOrCannotWH_IRRF

BRBuyer_IsExemptOrCannotWH_IRRF

boolean
brBuyer_IsExemptOrCannotWH_PISRF

BRBuyer_IsExemptOrCannotWH_PISRF

boolean
brBuyer_IsExemptOrCannotWH_COFINSRF

BRBuyer_IsExemptOrCannotWH_COFINSRF

boolean
brBuyer_IsExemptOrCannotWH_CSLLRF

BRBuyer_IsExemptOrCannotWH_CSLLRF

boolean
brBuyer_IsExempt_PIS

BRBuyer_IsExempt_PIS

boolean
brBuyer_IsExempt_COFINS

BRBuyer_IsExempt_COFINS

boolean
brBuyer_IsExempt_CSLL

BRBuyer_IsExempt_CSLL

boolean
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Lines]
id

DocumentLineId

integer
transactionId

DocumentId

integer
lineNumber

LineNo

string
method

AccountingMethodId

string
boundaryOverrideId

BoundaryOverrideId

integer
customerUsageType

CustomerUsageType

string
description

Description

string
destinationAddressId

DestinationAddressId

integer
discountAmount

DiscountAmount

number
discountTypeId

DiscountTypeId

integer
exemptAmount

ExemptAmount

number
exemptCertId

ExemptCertId

integer
exemptNo

ExemptNo

string
isItemTaxable

IsItemTaxable

boolean
isSSTP

IsSSTP

boolean
itemCode

ItemCode

string
lineAmount

LineAmount

number
originAddressId

OriginAddressId

integer
quantity

Quantity

number
ref1

Ref1

string
ref2

Ref2

string
reportingDate

ReportingDate

string
revAccount

RevAccount

string
sourcing

Sourcing

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxCalculated

TaxCalculated

number
taxCode

TaxCode

string
taxCodeId

TaxCodeId

integer
taxDate

TaxDate

string
taxEngine

TaxEngine

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
taxIncluded

TaxIncluded

boolean
Array[Details]
id

DocumentLineDetailId

integer
transactionLineId

DocumentLineId

integer
transactionId

DocumentId

integer
addressId

AddressId

integer
country

Country

string
region

Region

string
countyFIPS

CountyFips

string
stateFIPS

StateFips

string
exemptAmount

ExemptAmount

number
exemptReasonId

ExemptReasonId

integer
inState

InState

boolean
jurisCode

JurisCode

string
jurisName

JurisName

string
jurisdictionId

JurisdictionId

integer
jurisType

JurisTypeId

string
nonTaxableAmount

NonTaxableAmount

number
nonTaxableRuleId

NonTaxableRuleId

integer
nonTaxableType

NonTaxableTypeId

string
rate

Rate

number
rateRuleId

RateRuleId

integer
rateSourceId

RateSourceId

integer
signatureCode

SignatureCode

string
serCode

SERCode

string
sourcing

Sourcing

string
stateAssignedNo

StateAssignedNo

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxType

TaxTypeId

string
taxName

TaxName

string
taxAuthorityTypeId

TaxAuthorityTypeId

integer
taxRegionId

TaxRegionId

integer
taxCalculated

TaxCalculated

number
taxOverride

TaxOverride

number
rateType

RateTypeId

string
Array[Addresses]
id

DocumentAddressId

integer
transactionId

DocumentId

integer
boundaryLevel

BoundaryLevel

string
line1

AddressLine1

string
line2

AddressLine2

string
line3

AddressLine3

string
city

City

string
region

Region

string
postalCode

PostalCode

string
country

Country

string
taxRegionId

TaxRegionId

integer
Try Mark a transaction as posted to the ledger now!

Input

Reset

Path Parameters

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/transactions/{id}/post
Method
POST
Request
{}
Response
 

Create a new transaction

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/transactions/create

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Post Body Parameters[Array]

companyCode
Required

Company Code - The client application company reference code.

string
type

Document Type

string
code
Required

Transaction Code - the internal reference code used by the client application. This is used for operations such as Post and GetTaxHistory.

string
date
Required

Transaction Date - The date on the invoice, purchase order, etc.

string
salespersonCode

Salesperson Code - The client application salesperson reference code.

string
customerCode

Customer Code - The client application customer reference code.

string
customerUsageType

Customer Usage Type - The client application customer or usage type.

string
discount

Discount - The discount amount to apply to the document.

number
purchaseOrderNo

Purchase Order Number for this document

string
exemptionNo

Exemption Number for this document

string
Addresses
Unknown
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
ShipFrom
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
ShipTo
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
PointOfOrderAcceptance
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
PointOfOrderOrigin
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
SingleLocation
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
Other
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
Array[Lines]
number

Line number within this document

string
quantity
Required

Quantity of items in this line

number
amount
Required

Total amount for this line

number
Addresses
Unknown
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
ShipFrom
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
ShipTo
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
PointOfOrderAcceptance
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
PointOfOrderOrigin
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
SingleLocation
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
Other
line1

Line1

string
line2

Line2

string
line3

Line3

string
city

City

string
region

State / Province / Region

string
country

Two character ISO 3166 Country Code

string
postalCode

Postal Code / Zip Code

string
latitude

Geospatial latitude measurement

number
longitude

Geospatial longitude measurement

number
taxCode

Tax Code - System or Custom Tax Code.

string
customerUsageType

Customer Usage Type - The client application customer or usage type.

string
itemCode

Item Code (SKU)

string
exemptionCode

Exemption number for this line

string
discounted

True if the document discount should be applied to this line

boolean
taxIncluded

Indicates if line has Tax Included; defaults to false

boolean
revenueAccount

Revenue Account

string
ref1

Reference 1 - Client specific reference field

string
ref2

Reference 2 - Client specific reference field

string
description

Item description. This is required for SST transactions if an unmapped ItemCode is used.

string
businessIdentificationNo

BusinessIdentificationNo

string
TaxOverride
type

Identifies the type of tax override

string
taxAmount

Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines.

number
taxDate

The override tax date to use

string
reason

This provides the reason for a tax override for audit purposes. It is required for types 2-4.

string
referenceCode

Reference Code used to reference the original document for a return invoice

string
hashCode

The hash code is computed by the client to determine whether any changes have occured since taxes were calculated.

integer
reportingLocationCode

Sets the sale location code (Outlet ID) for reporting this document to the tax authority.

string
commit

Causes the document to be committed if true.

boolean
batchCode

BatchCode for batch operations.

string
TaxOverride
type

Identifies the type of tax override

string
taxAmount

Indicates a total override of the calculated tax on the document. AvaTax will distribute the override across all the lines.

number
taxDate

The override tax date to use

string
reason

This provides the reason for a tax override for audit purposes. It is required for types 2-4.

string
taxDate

Indicates the tax effectivity override date for the entire document.

string
currencyCode

3 character ISO 4217 currency code.

string
serviceMode

Specifies whether the tax calculation is handled Local, Remote, or Automatic (default)

string
paymentDate

Indicates the date payment was applied to this document. This is only for cash basis accounting.

string
exchangeRate

Currency exchange rate from this transaction to the company base currency.

number
exchangeRateEffectiveDate

Effective date of the exchange rate.

string
posLaneCode

Sets the POS Lane Code sent by the User for this document.

string
businessIdentificationNo

BusinessIdentificationNo

string
isSellerImporterOfRecord

Specifies if the Transaction has the seller as IsSellerImporterOfRecord

boolean
description

Description

string
email

Email

string

Response[Array]

id

DocumentId

integer
code

DocumentCode

string
date

DocumentDate

string
taxDate

TaxDate

string
paymentDate

PaymentDate

string
status

DocumentStatusId

string
type

DocumentTypeId

string
companyId

CompanyId

integer
batchCode

BatchCode

string
currencyCode

CurrencyCode

string
customerUsageType

CustomerUsageType

string
customerVendorCode

CustomerVendorCode

string
exemptNo

ExemptNo

string
reconciled

IsReconciled

boolean
locationCode

LocationCode

string
purchaseOrderNo

PurchaseOrderNo

string
referenceCode

ReferenceCode

string
salespersonCode

SalespersonCode

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
totalAmount

TotalAmount

number
totalExempt

TotalExempt

number
totalTax

TotalTax

number
totalTaxable

TotalTaxable

number
totalTaxCalculated

TotalTaxCalculated

number
adjustmentReason

AdjustmentReasonId

string
adjustmentDescription

AdjustmentDescription

string
locked

IsLocked

boolean
region

Region

string
country

Country

string
version

Version

integer
softwareVersion

SoftwareVersion

string
originAddressId

OriginAddressId

integer
destinationAddressId

DestinationAddressId

integer
exchangeRateEffectiveDate

ExchangeRateEffDate

string
exchangeRate

ExchangeRate

number
isSellerImporterOfRecord

IsSellerImporterOfRecord

boolean
description

Description

string
email

Email

string
brBuyerType

BRBuyerType

string
brBuyer_IsExemptOrCannotWH_IRRF

BRBuyer_IsExemptOrCannotWH_IRRF

boolean
brBuyer_IsExemptOrCannotWH_PISRF

BRBuyer_IsExemptOrCannotWH_PISRF

boolean
brBuyer_IsExemptOrCannotWH_COFINSRF

BRBuyer_IsExemptOrCannotWH_COFINSRF

boolean
brBuyer_IsExemptOrCannotWH_CSLLRF

BRBuyer_IsExemptOrCannotWH_CSLLRF

boolean
brBuyer_IsExempt_PIS

BRBuyer_IsExempt_PIS

boolean
brBuyer_IsExempt_COFINS

BRBuyer_IsExempt_COFINS

boolean
brBuyer_IsExempt_CSLL

BRBuyer_IsExempt_CSLL

boolean
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Lines]
id

DocumentLineId

integer
transactionId

DocumentId

integer
lineNumber

LineNo

string
method

AccountingMethodId

string
boundaryOverrideId

BoundaryOverrideId

integer
customerUsageType

CustomerUsageType

string
description

Description

string
destinationAddressId

DestinationAddressId

integer
discountAmount

DiscountAmount

number
discountTypeId

DiscountTypeId

integer
exemptAmount

ExemptAmount

number
exemptCertId

ExemptCertId

integer
exemptNo

ExemptNo

string
isItemTaxable

IsItemTaxable

boolean
isSSTP

IsSSTP

boolean
itemCode

ItemCode

string
lineAmount

LineAmount

number
originAddressId

OriginAddressId

integer
quantity

Quantity

number
ref1

Ref1

string
ref2

Ref2

string
reportingDate

ReportingDate

string
revAccount

RevAccount

string
sourcing

Sourcing

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxCalculated

TaxCalculated

number
taxCode

TaxCode

string
taxCodeId

TaxCodeId

integer
taxDate

TaxDate

string
taxEngine

TaxEngine

string
taxOverrideType

TaxOverrideTypeId

string
taxOverrideAmount

TaxOverrideAmount

number
taxOverrideReason

TaxOverrideReason

string
taxIncluded

TaxIncluded

boolean
Array[Details]
id

DocumentLineDetailId

integer
transactionLineId

DocumentLineId

integer
transactionId

DocumentId

integer
addressId

AddressId

integer
country

Country

string
region

Region

string
countyFIPS

CountyFips

string
stateFIPS

StateFips

string
exemptAmount

ExemptAmount

number
exemptReasonId

ExemptReasonId

integer
inState

InState

boolean
jurisCode

JurisCode

string
jurisName

JurisName

string
jurisdictionId

JurisdictionId

integer
jurisType

JurisTypeId

string
nonTaxableAmount

NonTaxableAmount

number
nonTaxableRuleId

NonTaxableRuleId

integer
nonTaxableType

NonTaxableTypeId

string
rate

Rate

number
rateRuleId

RateRuleId

integer
rateSourceId

RateSourceId

integer
signatureCode

SignatureCode

string
serCode

SERCode

string
sourcing

Sourcing

string
stateAssignedNo

StateAssignedNo

string
tax

Tax

number
taxableAmount

TaxableAmount

number
taxType

TaxTypeId

string
taxName

TaxName

string
taxAuthorityTypeId

TaxAuthorityTypeId

integer
taxRegionId

TaxRegionId

integer
taxCalculated

TaxCalculated

number
taxOverride

TaxOverride

number
rateType

RateTypeId

string
Array[Addresses]
id

DocumentAddressId

integer
transactionId

DocumentId

integer
boundaryLevel

BoundaryLevel

string
line1

AddressLine1

string
line2

AddressLine2

string
line3

AddressLine3

string
city

City

string
region

Region

string
postalCode

PostalCode

string
country

Country

string
taxRegionId

TaxRegionId

integer
Try Create a new transaction now!

Input

Reset

Post Body

item 1

addresses

Unknown

ShipFrom

ShipTo

PointOfOrderAcceptance

PointOfOrderOrigin

SingleLocation

Other

lines

item 1

addresses

Unknown

ShipFrom

ShipTo

PointOfOrderAcceptance

PointOfOrderOrigin

SingleLocation

Other

taxOverride

Add lines

taxOverride

Add Item
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/transactions/create
Method
POST
Request
[
  {
    "addresses": {
      "Unknown": {},
      "ShipFrom": {},
      "ShipTo": {},
      "PointOfOrderAcceptance": {},
      "PointOfOrderOrigin": {},
      "SingleLocation": {},
      "Other": {}
    },
    "lines": [
      {
        "addresses": {
          "Unknown": {},
          "ShipFrom": {},
          "ShipTo": {},
          "PointOfOrderAcceptance": {},
          "PointOfOrderOrigin": {},
          "SingleLocation": {},
          "Other": {}
        },
        "taxOverride": {}
      }
    ],
    "taxOverride": {}
  }
]
Response
 

Retrieve a single UPC

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/upcs/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this UPC

integer
id
Required

The primary key of this UPC

integer

Response

id

Id

integer
companyId

CompanyId

integer
upc
Required

UPC

string
legacyTaxCode

Legacy Tax Code

string
description
Required

Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
usage

Usage

integer
isSystem

IsSystem

integer
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Retrieve a single UPC now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/upcs/{id}
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/upcs/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Update a single UPC

Api Endpoint
PUT https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/upcs/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that this UPC belongs to.

integer
id
Required

The ID of the UPC you wish to update

integer

Post Body Parameters

id

Id

integer
companyId

CompanyId

integer
upc
Required

UPC

string
legacyTaxCode

Legacy Tax Code

string
description
Required

Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
usage

Usage

integer
isSystem

IsSystem

integer
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response

id

Id

integer
companyId

CompanyId

integer
upc
Required

UPC

string
legacyTaxCode

Legacy Tax Code

string
description
Required

Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
usage

Usage

integer
isSystem

IsSystem

integer
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Update a single UPC now!

Input

Reset

Path Parameters

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/upcs/{id}
Method
PUT
Request
{}
Response
 

Delete a single UPC

Api Endpoint
DELETE https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/upcs/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this UPC.

integer
id
Required

The ID of the UPC you wish to delete.

integer

Response

Error
code

Category of the error

string
message

Short one-line message to summaryize what went wrong

string
target

What object or service caused the error?

string
Array[Details]
errorCode

Error message identifier

integer
summary

Concise summary of the message

string
details

Message details

string
faultCode

Indicates the SoapFault code

string
helpLink

URL to help for this message

string
name

Name of the message.

string
refersTo

Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.

string
severity

Severity of the message

string
source

Source of the message

string
documentation

Documentation of the message

string
Try Delete a single UPC now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/upcs/{id}
Method
DELETE
Request
curl -X DELETE "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/upcs/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve UPCs for this company

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/upcs

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Path Parameters

companyId
Required

The ID of the company that owns these UPCs

integer

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
companyId

CompanyId

integer
upc
Required

UPC

string
legacyTaxCode

Legacy Tax Code

string
description
Required

Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
usage

Usage

integer
isSystem

IsSystem

integer
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve UPCs for this company now!

Input

Reset

Path Parameters

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/upcs
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/upcs" -H "Accept: application/json" -H "Authorization: "
Response
 

Create a new UPC

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/upcs

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

companyId
Required

The ID of the company that owns this UPC.

integer

Post Body Parameters[Array]

id

Id

integer
companyId

CompanyId

integer
upc
Required

UPC

string
legacyTaxCode

Legacy Tax Code

string
description
Required

Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
usage

Usage

integer
isSystem

IsSystem

integer
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response[Array]

id

Id

integer
companyId

CompanyId

integer
upc
Required

UPC

string
legacyTaxCode

Legacy Tax Code

string
description
Required

Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
usage

Usage

integer
isSystem

IsSystem

integer
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Create a new UPC now!

Input

Reset

Path Parameters

Post Body

item 1

Add Item
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/companies/{companyId}/upcs
Method
POST
Request
[
  {}
]
Response
 

Retrieve all UPCs

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/upcs

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

Id

integer
companyId

CompanyId

integer
upc
Required

UPC

string
legacyTaxCode

Legacy Tax Code

string
description
Required

Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
usage

Usage

integer
isSystem

IsSystem

integer
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve all UPCs now!

Input

Reset

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/upcs
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/upcs" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve a single user

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/users/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$include

A comma separated list of child objects to return underneath the primary object.

string

Path Parameters

id
Required

The ID of the user to retrieve.

integer
accountId
Required

The accountID of the user you wish to get.

integer

Response

id

id

integer
accountId

accountId

integer
userName
Required

userName

string
firstName

firstName

string
lastName

lastName

string
email
Required

email

string
postalCode
Required

postalCode

string
securityRoleId

securityRoleId

string
companyId

companyId

integer
passwordStatus

passwordStatus

string
isActive

isActive

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Retrieve a single user now!

Input

Reset

Path Parameters

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/users/{id}
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/users/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Update a single user

Api Endpoint
PUT https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/users/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

id
Required

The ID of the user you wish to update.

integer
accountId
Required

The accountID of the user you wish to update.

integer

Post Body Parameters

id

id

integer
accountId

accountId

integer
userName
Required

userName

string
firstName

firstName

string
lastName

lastName

string
email
Required

email

string
postalCode
Required

postalCode

string
securityRoleId

securityRoleId

string
companyId

companyId

integer
passwordStatus

passwordStatus

string
isActive

isActive

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response

id

Id

integer
name
Required

Name

string
effectiveDate

Effective Date

string
endDate

End Date

string
accountStatusId

Account Status Id

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Subscriptions]
id

Id

integer
accountId

Account Id

integer
subscriptionTypeId

Subscription Type Id

integer
subscriptionDescription

Subscription Description

string
effectiveDate

Effective Date

string
endDate

End Date

string
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Array[Users]
id

id

integer
accountId

accountId

integer
userName
Required

userName

string
firstName

firstName

string
lastName

lastName

string
email
Required

email

string
postalCode
Required

postalCode

string
securityRoleId

securityRoleId

string
companyId

companyId

integer
passwordStatus

passwordStatus

string
isActive

isActive

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Update a single user now!

Input

Reset

Path Parameters

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/users/{id}
Method
PUT
Request
{}
Response
 

Delete a single user

Api Endpoint
DELETE https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/users/{id}

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

id
Required

The ID of the user you wish to delete.

integer
accountId
Required

The accountID of the user you wish to delete.

integer

Response

Error
code

Category of the error

string
message

Short one-line message to summaryize what went wrong

string
target

What object or service caused the error?

string
Array[Details]
errorCode

Error message identifier

integer
summary

Concise summary of the message

string
details

Message details

string
faultCode

Indicates the SoapFault code

string
helpLink

URL to help for this message

string
name

Name of the message.

string
refersTo

Item the message refers to, if applicable. This is used to indicate a missing or incorrect value.

string
severity

Severity of the message

string
source

Source of the message

string
documentation

Documentation of the message

string
Try Delete a single user now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/users/{id}
Method
DELETE
Request
curl -X DELETE "https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/users/{id}" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve users for this account

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/users

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$include

A comma separated list of child objects to return underneath the primary object.

string
$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Path Parameters

accountId
Required

The accountID of the user you wish to list.

integer

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

id

integer
accountId

accountId

integer
userName
Required

userName

string
firstName

firstName

string
lastName

lastName

string
email
Required

email

string
postalCode
Required

postalCode

string
securityRoleId

securityRoleId

string
companyId

companyId

integer
passwordStatus

passwordStatus

string
isActive

isActive

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve users for this account now!

Input

Reset

Path Parameters

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/users
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/users" -H "Accept: application/json" -H "Authorization: "
Response
 

Create a new user

Api Endpoint
POST https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/users

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

accountId
Required

The accountID of the user you wish to create.

integer

Post Body Parameters

id

id

integer
accountId

accountId

integer
userName
Required

userName

string
firstName

firstName

string
lastName

lastName

string
email
Required

email

string
postalCode
Required

postalCode

string
securityRoleId

securityRoleId

string
companyId

companyId

integer
passwordStatus

passwordStatus

string
isActive

isActive

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer

Response

id

id

integer
accountId

accountId

integer
userName
Required

userName

string
firstName

firstName

string
lastName

lastName

string
email
Required

email

string
postalCode
Required

postalCode

string
securityRoleId

securityRoleId

string
companyId

companyId

integer
passwordStatus

passwordStatus

string
isActive

isActive

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
Try Create a new user now!

Input

Reset

Path Parameters

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/users
Method
POST
Request
{}
Response
 

Retrieve all users

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/users

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Querystring Parameters

$include

A comma separated list of child objects to return underneath the primary object.

string
$filter

A filter statement to identify specific records to retrieve, as defined by https://github.com/Microsoft/api-guidelines/blob/master/Guidelines.md#97-filtering .

string
$top

If nonzero, return no more than this number of results.

integer
$skip

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

integer
$orderBy

A comma separated list of sort statements in the format '(fieldname) [ASC|DESC]', for example 'id ASC'.

string

Response

@recordsetCount

The number of rows returned by your query, prior to pagination.

integer
Array[Value]
id

id

integer
accountId

accountId

integer
userName
Required

userName

string
firstName

firstName

string
lastName

lastName

string
email
Required

email

string
postalCode
Required

postalCode

string
securityRoleId

securityRoleId

string
companyId

companyId

integer
passwordStatus

passwordStatus

string
isActive

isActive

boolean
createdDate

The date when this record was created (read only)

string
createdUserId

The User ID of the user who created this record (read only)

integer
modifiedDate

The date/time when this record was last modified (read only)

string
modifiedUserId

The user ID of the user who last modified this record (read only)

integer
@nextLink

The link to the next page of results

string
Try Retrieve all users now!

Input

Reset

Query String

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/users
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/users" -H "Accept: application/json" -H "Authorization: "
Response
 

Retrieve all entitlements for a single user

Api Endpoint
GET https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/users/{id}/entitlements

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Path Parameters

id
Required

The ID of the user to retrieve.

integer
accountId
Required

The accountID of the user you wish to get.

integer

Response

permissions
Array[string]
company

Company

string
companies
Array[integer]
Try Retrieve all entitlements for a single user now!

Input

Reset

Path Parameters

API Endpoint
https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/users/{id}/entitlements
Method
GET
Request
curl -X GET "https://rest-sbx-preview.avalara.net/api/v2/accounts/{accountId}/users/{id}/entitlements" -H "Accept: application/json" -H "Authorization: "
Response
 

Tests connectivity and version of the service

Api Endpoint
GET https://rest-sbx-preview.avalara.net/utilities/ping

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Response

version

Version number

string
Try Tests connectivity and version of the service now!

Input

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/utilities/ping
Method
GET
Response
 

Checks authentication and authorization to one or more operations on the service.

Api Endpoint
POST https://rest-sbx-preview.avalara.net/utilities/isauthorized

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Post Body Parameters[Array]

Post Body Parameters
Array[string]
Try Checks authentication and authorization to one or more operations on the service. now!

Input

Reset

Post Body

Add Item
Reset
API Endpoint
https://rest-sbx-preview.avalara.net/utilities/isauthorized
Method
POST
Request
[
  null
]
Response
 

Checks if service is authorized for given service type

Api Endpoint
POST https://rest-sbx-preview.avalara.net/utilities/isserviceauthorized

Headers
Authorization: Basic aHR0cHdhdGNoOmY=

Post Body Parameters

serviceTypeId
Required

Service Type Id

string
forDate
Required

For Date

string
Try Checks if service is authorized for given service type now!

Input

Reset

Post Body

Reset
API Endpoint
https://rest-sbx-preview.avalara.net/utilities/isserviceauthorized
Method
POST
Request
{}
Response